#include <Aspect_Grid.hxx>

Inheritance diagram for Aspect_Grid:

[legend]

Public Member Functions
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.

virtual void	SetColors (const Quantity_Color &aColor, const Quantity_Color &aTenthColor)
	Change the colors of the grid.

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.

virtual void	Compute (const Standard_Real X, const Standard_Real Y, Standard_Real &gridX, Standard_Real &gridY) const =0
	returns the point of the grid the closest to the point 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.

virtual void	Display ()=0
	Display the grid at screen.

virtual void	Erase () const =0
	Erase the grid from screen.

virtual Standard_Boolean	IsDisplayed () const =0
	Returns TRUE when the grid is displayed at screen.

virtual void	Init ()=0

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.

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
	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.

virtual void	UpdateDisplay ()=0
	Updates the grid parameters.

Protected Attributes
Standard_Real	myRotationAngle

Standard_Real	myXOrigin

Standard_Real	myYOrigin

Quantity_Color	myColor

Quantity_Color	myTenthColor

Standard_Boolean	myIsActive

Aspect_GridDrawMode	myDrawMode

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.

Constructor & Destructor Documentation

◆ Aspect_Grid()

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`
	)

protected

Creates a new grid. By default this grid is not active.

Member Function Documentation

◆ Activate()

void Aspect_Grid::Activate ( )

inline

activates the grid. The Hit method will return gridx and gridx computed according to the steps of the grid.

◆ Colors()

void Aspect_Grid::Colors	(	Quantity_Color &	aColor,
		Quantity_Color &	aTenthColor
	)		const

Returns the colors of the grid.

◆ Compute()

virtual void Aspect_Grid::Compute	(	const Standard_Real	X,
		const Standard_Real	Y,
		Standard_Real &	gridX,
		Standard_Real &	gridY
	)		const

pure virtual

returns the point of the grid the closest to the point X,Y

Implemented in Aspect_CircularGrid, and Aspect_RectangularGrid.

◆ Deactivate()

void Aspect_Grid::Deactivate ( )

inline

deactivates the grid. The hit method will return gridx and gridx as the enter value X & Y.

◆ Display()

virtual void Aspect_Grid::Display ( )

pure virtual

Display the grid at screen.

Implemented in V3d_CircularGrid, and V3d_RectangularGrid.

◆ DrawMode()

Aspect_GridDrawMode Aspect_Grid::DrawMode ( ) const

inline

Returns the grid aspect.

◆ DumpJson()

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

virtual

Dumps the content of me into the stream.

Reimplemented in Aspect_CircularGrid, Aspect_RectangularGrid, V3d_CircularGrid, and V3d_RectangularGrid.

◆ Erase()

virtual void Aspect_Grid::Erase ( ) const

pure virtual

Erase the grid from screen.

Implemented in V3d_CircularGrid, and V3d_RectangularGrid.

◆ Hit()

void Aspect_Grid::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.

◆ Init()

virtual void Aspect_Grid::Init ( )

pure virtual

Implemented in Aspect_CircularGrid, and Aspect_RectangularGrid.

◆ IsActive()

Standard_Boolean Aspect_Grid::IsActive ( ) const

inline

Returns TRUE when the grid is active.

◆ IsDisplayed()

virtual Standard_Boolean Aspect_Grid::IsDisplayed ( ) const

pure virtual

Returns TRUE when the grid is displayed at screen.

Implemented in V3d_CircularGrid, and V3d_RectangularGrid.

◆ Rotate()

void Aspect_Grid::Rotate ( const Standard_Real anAngle )

Rotate the grid from a relative angle.

◆ RotationAngle()

Standard_Real Aspect_Grid::RotationAngle ( ) const

inline

returns the x Angle of the grid.

◆ SetColors()

virtual void Aspect_Grid::SetColors	(	const Quantity_Color &	aColor,
		const Quantity_Color &	aTenthColor
	)

virtual

Change the colors of the grid.

Reimplemented in V3d_CircularGrid, and V3d_RectangularGrid.

◆ SetDrawMode()

void Aspect_Grid::SetDrawMode ( const Aspect_GridDrawMode aDrawMode )

Change the grid aspect.

◆ SetRotationAngle()

void Aspect_Grid::SetRotationAngle ( const Standard_Real anAngle )

defines the orientation of the grid.

◆ SetXOrigin()

void Aspect_Grid::SetXOrigin ( const Standard_Real anOrigin )

defines the x Origin of the grid.

◆ SetYOrigin()

void Aspect_Grid::SetYOrigin ( const Standard_Real anOrigin )

defines the y Origin of the grid.

◆ Translate()

void Aspect_Grid::Translate	(	const Standard_Real	aDx,
		const Standard_Real	aDy
	)

Translate the grid from a relative distance.

◆ UpdateDisplay()

virtual void Aspect_Grid::UpdateDisplay ( )

protectedpure virtual

Updates the grid parameters.

Implemented in V3d_CircularGrid, and V3d_RectangularGrid.

◆ XOrigin()

Standard_Real Aspect_Grid::XOrigin ( ) const

inline

returns the x Origin of the grid.

◆ YOrigin()

Standard_Real Aspect_Grid::YOrigin ( ) const

inline

returns the x Origin of the grid.

Field Documentation

◆ myColor

Quantity_Color Aspect_Grid::myColor

protected

◆ myDrawMode

Aspect_GridDrawMode Aspect_Grid::myDrawMode

protected

◆ myIsActive

Standard_Boolean Aspect_Grid::myIsActive

protected

◆ myRotationAngle

Standard_Real Aspect_Grid::myRotationAngle

protected

◆ myTenthColor

Quantity_Color Aspect_Grid::myTenthColor

protected

◆ myXOrigin

Standard_Real Aspect_Grid::myXOrigin

protected

◆ myYOrigin

Standard_Real Aspect_Grid::myYOrigin

protected

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

Aspect_Grid.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Aspect_Grid()

Member Function Documentation

◆ Activate()

◆ Colors()

◆ Compute()

◆ Deactivate()

◆ Display()

◆ DrawMode()

◆ DumpJson()

◆ Erase()

◆ Hit()

◆ Init()

◆ IsActive()

◆ IsDisplayed()

◆ Rotate()

◆ RotationAngle()

◆ SetColors()

◆ SetDrawMode()

◆ SetRotationAngle()

◆ SetXOrigin()

◆ SetYOrigin()

◆ Translate()

◆ UpdateDisplay()

◆ XOrigin()

◆ YOrigin()

Field Documentation

◆ myColor

◆ myDrawMode

◆ myIsActive

◆ myRotationAngle

◆ myTenthColor

◆ myXOrigin

◆ myYOrigin