#include <Aspect_CircularGrid.hxx>
Inheritance diagram for Aspect_CircularGrid:
Public Member Functions | |
| Aspect_CircularGrid (const Standard_Real aRadiusStep, const Standard_Integer aDivisionNumber, const Standard_Real XOrigin=0, const Standard_Real anYOrigin=0, const Standard_Real aRotationAngle=0) | |
| creates a new grid. By default this grid is not active. More... | |
| void | SetRadiusStep (const Standard_Real aStep) |
| defines the x step of the grid. More... | |
| void | SetDivisionNumber (const Standard_Integer aNumber) |
| defines the step of the grid. More... | |
| void | SetGridValues (const Standard_Real XOrigin, const Standard_Real YOrigin, const Standard_Real RadiusStep, const Standard_Integer DivisionNumber, const Standard_Real RotationAngle) |
| virtual void | Compute (const Standard_Real X, const Standard_Real Y, Standard_Real &gridX, Standard_Real &gridY) const override |
| returns the point of the grid the closest to the point X,Y More... | |
| Standard_Real | RadiusStep () const |
| returns the x step of the grid. More... | |
| Standard_Integer | DivisionNumber () const |
| returns the x step of the grid. More... | |
| virtual void | Init () override |
| virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override |
| Dumps the content of me into the stream. More... | |
 Public Member Functions inherited from Aspect_Grid | |
| void | SetXOrigin (const Standard_Real anOrigin) |
| defines the x Origin of the grid. More... | |
| void | SetYOrigin (const Standard_Real anOrigin) |
| defines the y Origin of the grid. More... | |
| void | SetRotationAngle (const Standard_Real anAngle) |
| defines the orientation of the grid. More... | |
| void | Rotate (const Standard_Real anAngle) |
| Rotate the grid from a relative angle. More... | |
| void | Translate (const Standard_Real aDx, const Standard_Real aDy) |
| Translate the grid from a relative distance. More... | |
| virtual void | SetColors (const Quantity_Color &aColor, const Quantity_Color &aTenthColor) |
| Change the colors of the grid. More... | |
| void | Hit (const Standard_Real X, const Standard_Real Y, Standard_Real &gridX, Standard_Real &gridY) const |
| returns the point of the grid the closest to the point X,Y if the grid is active. If the grid is not active returns X,Y. More... | |
| void | Activate () |
| activates the grid. The Hit method will return gridx and gridx computed according to the steps of the grid. More... | |
| void | Deactivate () |
| deactivates the grid. The hit method will return gridx and gridx as the enter value X & Y. More... | |
| Standard_Real | XOrigin () const |
| returns the x Origin of the grid. More... | |
| Standard_Real | YOrigin () const |
| returns the x Origin of the grid. More... | |
| Standard_Real | RotationAngle () const |
| returns the x Angle of the grid. More... | |
| Standard_Boolean | IsActive () const |
| Returns TRUE when the grid is active. More... | |
| void | Colors (Quantity_Color &aColor, Quantity_Color &aTenthColor) const |
| Returns the colors of the grid. More... | |
| void | SetDrawMode (const Aspect_GridDrawMode aDrawMode) |
| Change the grid aspect. More... | |
| Aspect_GridDrawMode | DrawMode () const |
| Returns the grid aspect. More... | |
| virtual void | Display ()=0 |
| Display the grid at screen. More... | |
| virtual void | Erase () const =0 |
| Erase the grid from screen. More... | |
| virtual Standard_Boolean | IsDisplayed () const =0 |
| Returns TRUE when the grid is displayed at screen. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
| Protected Member Functions inherited from Aspect_Grid | |
| Aspect_Grid (const Standard_Real theXOrigin=0.0, const Standard_Real theYOrigin=0.0, const Standard_Real theRotationAngle=0, const Quantity_Color &theColor=Quantity_NOC_GRAY50, const Quantity_Color &theTenthColor=Quantity_NOC_GRAY70) | |
| Creates a new grid. By default this grid is not active. More... | |
| virtual void | UpdateDisplay ()=0 |
| Updates the grid parameters. More... | |
| Protected Attributes inherited from Aspect_Grid | |
| Standard_Real | myRotationAngle |
| Standard_Real | myXOrigin |
| Standard_Real | myYOrigin |
| Quantity_Color | myColor |
| Quantity_Color | myTenthColor |
| Standard_Boolean | myIsActive |
| Aspect_GridDrawMode | myDrawMode |
Constructor & Destructor Documentation
◆ Aspect_CircularGrid()
| Aspect_CircularGrid::Aspect_CircularGrid | ( | const Standard_Real | aRadiusStep, |
| const Standard_Integer | aDivisionNumber, | ||
| const Standard_Real | XOrigin = 0, |
||
| const Standard_Real | anYOrigin = 0, |
||
| const Standard_Real | aRotationAngle = 0 |
||
| ) |
creates a new grid. By default this grid is not active.
Member Function Documentation
◆ Compute()
|
overridevirtual |
returns the point of the grid the closest to the point X,Y
Implements Aspect_Grid.
◆ DivisionNumber()
| Standard_Integer Aspect_CircularGrid::DivisionNumber | ( | ) | const |
returns the x step of the grid.
◆ DumpJson()
|
overridevirtual |
Dumps the content of me into the stream.
Reimplemented from Aspect_Grid.
Reimplemented in V3d_CircularGrid.
◆ Init()
|
overridevirtual |
Implements Aspect_Grid.
◆ RadiusStep()
| Standard_Real Aspect_CircularGrid::RadiusStep | ( | ) | const |
returns the x step of the grid.
◆ SetDivisionNumber()
| void Aspect_CircularGrid::SetDivisionNumber | ( | const Standard_Integer | aNumber | ) |
defines the step of the grid.
◆ SetGridValues()
| void Aspect_CircularGrid::SetGridValues | ( | const Standard_Real | XOrigin, |
| const Standard_Real | YOrigin, | ||
| const Standard_Real | RadiusStep, | ||
| const Standard_Integer | DivisionNumber, | ||
| const Standard_Real | RotationAngle | ||
| ) |
◆ SetRadiusStep()
| void Aspect_CircularGrid::SetRadiusStep | ( | const Standard_Real | aStep | ) |
defines the x step of the grid.
The documentation for this class was generated from the following file:
