Open CASCADE Technology  6.9.1
Public Member Functions | Protected Member Functions
V3d_CircularGrid Class Reference

#include <V3d_CircularGrid.hxx>

Inheritance diagram for V3d_CircularGrid:
Inheritance graph
[legend]

Public Member Functions

 V3d_CircularGrid (const V3d_ViewerPointer &aViewer, const Quantity_Color &aColor, const Quantity_Color &aTenthColor)
 
void SetColors (const Quantity_Color &aColor, const Quantity_Color &aTenthColor)
 Change the colors of the grid. More...
 
void Display ()
 Display the grid at screen. More...
 
void Erase () const
 Erase the grid from screen. More...
 
Standard_Boolean IsDisplayed () const
 Returns TRUE when the grid is displayed at screen. More...
 
void GraphicValues (Standard_Real &Radius, Standard_Real &OffSet) const
 
void SetGraphicValues (const Standard_Real Radius, const Standard_Real OffSet)
 
- Public Member Functions inherited from Aspect_CircularGrid
 Aspect_CircularGrid (const Quantity_Length aRadiusStep, const Standard_Integer aDivisionNumber, const Quantity_Length XOrigin=0, const Quantity_Length anYOrigin=0, const Quantity_PlaneAngle aRotationAngle=0)
 creates a new grid. By default this grid is not active. More...
 
void SetRadiusStep (const Quantity_Length 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 Quantity_Length XOrigin, const Quantity_Length YOrigin, const Quantity_Length RadiusStep, const Standard_Integer DivisionNumber, const Quantity_PlaneAngle RotationAngle)
 
void Compute (const Quantity_Length X, const Quantity_Length Y, Quantity_Length &gridX, Quantity_Length &gridY) const
 returns the point of the grid the closest to the point X,Y More...
 
Quantity_Length RadiusStep () const
 returns the x step of the grid. More...
 
Standard_Integer DivisionNumber () const
 returns the x step of the grid. More...
 
void Init ()
 
- Public Member Functions inherited from Aspect_Grid
void SetXOrigin (const Quantity_Length anOrigin)
 defines the x Origin of the grid. More...
 
void SetYOrigin (const Quantity_Length anOrigin)
 defines the y Origin of the grid. More...
 
void SetRotationAngle (const Quantity_PlaneAngle anAngle)
 defines the orientation of the the grid. More...
 
void Rotate (const Quantity_PlaneAngle anAngle)
 Rotate the grid from a relative angle. More...
 
void Translate (const Quantity_Length aDx, const Quantity_Length aDy)
 Translate the grid from a relative distance. More...
 
void Hit (const Quantity_Length X, const Quantity_Length Y, Quantity_Length &gridX, Quantity_Length &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...
 
Quantity_Length XOrigin () const
 returns the x Origin of the grid. More...
 
Quantity_Length YOrigin () const
 returns the x Origin of the grid. More...
 
Quantity_PlaneAngle 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...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const Handle_Standard_Type & DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Member Functions

void UpdateDisplay ()
 Updates the grid parameters. More...
 
- Protected Member Functions inherited from Aspect_Grid
 Aspect_Grid (const Quantity_Length anXOrigin=0.0, const Quantity_Length anYOrigin=0.0, const Quantity_PlaneAngle aRotationAngle=0, const Quantity_Color &aColor=Quantity_NOC_GRAY50, const Quantity_Color &aTenthColor=Quantity_NOC_GRAY70)
 creates a new grid. By default this grid is not active. More...
 

Additional Inherited Members

- Protected Attributes inherited from Aspect_Grid
Quantity_PlaneAngle myRotationAngle
 
Quantity_Length myXOrigin
 
Quantity_Length myYOrigin
 
Quantity_Color myColor
 
Quantity_Color myTenthColor
 

Constructor & Destructor Documentation

V3d_CircularGrid::V3d_CircularGrid ( const V3d_ViewerPointer aViewer,
const Quantity_Color aColor,
const Quantity_Color aTenthColor 
)

Member Function Documentation

void V3d_CircularGrid::Display ( )
virtual

Display the grid at screen.

Reimplemented from Aspect_Grid.

void V3d_CircularGrid::Erase ( ) const
virtual

Erase the grid from screen.

Reimplemented from Aspect_Grid.

void V3d_CircularGrid::GraphicValues ( Standard_Real Radius,
Standard_Real OffSet 
) const
Standard_Boolean V3d_CircularGrid::IsDisplayed ( ) const
virtual

Returns TRUE when the grid is displayed at screen.

Reimplemented from Aspect_Grid.

void V3d_CircularGrid::SetColors ( const Quantity_Color aColor,
const Quantity_Color aTenthColor 
)
virtual

Change the colors of the grid.

Reimplemented from Aspect_Grid.

void V3d_CircularGrid::SetGraphicValues ( const Standard_Real  Radius,
const Standard_Real  OffSet 
)
void V3d_CircularGrid::UpdateDisplay ( )
protectedvirtual

Updates the grid parameters.

Reimplemented from Aspect_Grid.


The documentation for this class was generated from the following file: