V3d_CircularGrid Class Reference

#include <V3d_CircularGrid.hxx>

Inheritance diagram for V3d_CircularGrid:

Public Member Functions
	V3d_CircularGrid (const V3d_ViewerPointer &aViewer, const Quantity_Color &aColor, const Quantity_Color &aTenthColor)
virtual	~V3d_CircularGrid ()
void	SetColors (const Quantity_Color &aColor, const Quantity_Color &aTenthColor) override
	Change the colors of the grid.
void	Display () override
	Display the grid at screen.
void	Erase () const override
	Erase the grid from screen.
Standard_Boolean	IsDisplayed () const override
	Returns TRUE when the grid is displayed at screen.
void	GraphicValues (Standard_Real &Radius, Standard_Real &OffSet) const
void	SetGraphicValues (const Standard_Real Radius, const Standard_Real OffSet)
virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.
Public Member Functions inherited from 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.
void	SetRadiusStep (const Standard_Real aStep)
	defines the x step of the grid.
void	SetDivisionNumber (const Standard_Integer aNumber)
	defines the step of the grid.
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
Standard_Real	RadiusStep () const
	returns the x step of the grid.
Standard_Integer	DivisionNumber () const
	returns the x step of the grid.
virtual void	Init () override
Public Member Functions inherited from Aspect_Grid
void	SetXOrigin (const Standard_Real anOrigin)
	defines the x Origin of the grid.
void	SetYOrigin (const Standard_Real anOrigin)
	defines the y Origin of the grid.
void	SetRotationAngle (const Standard_Real anAngle)
	defines the orientation of the grid.
void	Rotate (const Standard_Real anAngle)
	Rotate the grid from a relative angle.
void	Translate (const Standard_Real aDx, const Standard_Real aDy)
	Translate the grid from a relative distance.
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.
void	Activate ()
	activates the grid. The Hit method will return gridx and gridx computed according to the steps of the grid.
void	Deactivate ()
	deactivates the grid. The hit method will return gridx and gridx as the enter value X & Y.
Standard_Real	XOrigin () const
	returns the x Origin of the grid.
Standard_Real	YOrigin () const
	returns the x Origin of the grid.
Standard_Real	RotationAngle () const
	returns the x Angle of the grid.
Standard_Boolean	IsActive () const
	Returns TRUE when the grid is active.
void	Colors (Quantity_Color &aColor, Quantity_Color &aTenthColor) const
	Returns the colors of the grid.
void	SetDrawMode (const Aspect_GridDrawMode aDrawMode)
	Change the grid aspect.
Aspect_GridDrawMode	DrawMode () const
	Returns the grid aspect.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
void	UpdateDisplay () override
	Updates the grid parameters.
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.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
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

V3d_CircularGrid()

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

~V3d_CircularGrid()

virtual V3d_CircularGrid::~V3d_CircularGrid ( )

virtual

Member Function Documentation

Display()

void V3d_CircularGrid::Display ( )

overridevirtual

Display the grid at screen.

Implements Aspect_Grid.

DumpJson()

virtual void V3d_CircularGrid::DumpJson ( Standard_OStream & theOStream, Standard_Integer theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Aspect_CircularGrid.

Erase()

void V3d_CircularGrid::Erase ( ) const

overridevirtual

Erase the grid from screen.

Implements Aspect_Grid.

GraphicValues()

void V3d_CircularGrid::GraphicValues	(	Standard_Real &	Radius,
		Standard_Real &	OffSet ) const

IsDisplayed()

Standard_Boolean V3d_CircularGrid::IsDisplayed ( ) const

overridevirtual

Returns TRUE when the grid is displayed at screen.

Implements Aspect_Grid.

SetColors()

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

overridevirtual

Change the colors of the grid.

Reimplemented from Aspect_Grid.

SetGraphicValues()

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

UpdateDisplay()

void V3d_CircularGrid::UpdateDisplay ( )

overrideprotectedvirtual

Updates the grid parameters.

Implements Aspect_Grid.

---

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

• V3d_CircularGrid.hxx