#include <Aspect_Grid.hxx>

Inheritance diagram for Aspect_Grid:

[legend]

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

virtual void	SetColors (const Quantity_Color &aColor, const Quantity_Color &aTenthColor)
	Change the colors of the grid. 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...

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

virtual void	Display ()
	Display the grid at screen. More...

virtual void	Erase () const
	Erase the grid from screen. More...

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

virtual void	Init ()=0

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_Transient &	operator= (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
	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...

virtual void	UpdateDisplay ()
	Updates the grid parameters. More...

Protected Attributes
Quantity_PlaneAngle	myRotationAngle

Quantity_Length	myXOrigin

Quantity_Length	myYOrigin

Quantity_Color	myColor

Quantity_Color	myTenthColor

Constructor & Destructor Documentation

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

protected

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

Member Function Documentation

void Aspect_Grid::Activate ( )

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

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

Returns the colors of the grid.

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

pure virtual

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

Implemented in Aspect_RectangularGrid, and Aspect_CircularGrid.

void Aspect_Grid::Deactivate ( )

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

virtual void Aspect_Grid::Display ( )

virtual

Display the grid at screen.

Reimplemented in V3d_CircularGrid, and V3d_RectangularGrid.

Aspect_GridDrawMode Aspect_Grid::DrawMode ( ) const

Returns the grid aspect.

virtual void Aspect_Grid::Erase ( ) const

virtual

Erase the grid from screen.

Reimplemented in V3d_CircularGrid, and V3d_RectangularGrid.

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

virtual void Aspect_Grid::Init ( )

pure virtual

Implemented in Aspect_RectangularGrid, and Aspect_CircularGrid.

Standard_Boolean Aspect_Grid::IsActive ( ) const

Returns TRUE when the grid is active.

virtual Standard_Boolean Aspect_Grid::IsDisplayed ( ) const

virtual

Returns TRUE when the grid is displayed at screen.

Reimplemented in V3d_CircularGrid, and V3d_RectangularGrid.

void Aspect_Grid::Rotate ( const Quantity_PlaneAngle anAngle )

Rotate the grid from a relative angle.

Quantity_PlaneAngle Aspect_Grid::RotationAngle ( ) const

returns the x Angle of the grid.

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.

void Aspect_Grid::SetDrawMode ( const Aspect_GridDrawMode aDrawMode )

Change the grid aspect.

void Aspect_Grid::SetRotationAngle ( const Quantity_PlaneAngle anAngle )

defines the orientation of the the grid.

void Aspect_Grid::SetXOrigin ( const Quantity_Length anOrigin )

defines the x Origin of the grid.

void Aspect_Grid::SetYOrigin ( const Quantity_Length anOrigin )

defines the y Origin of the grid.

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

Translate the grid from a relative distance.

virtual void Aspect_Grid::UpdateDisplay ( )

protectedvirtual

Updates the grid parameters.

Reimplemented in V3d_CircularGrid, and V3d_RectangularGrid.

Quantity_Length Aspect_Grid::XOrigin ( ) const

returns the x Origin of the grid.

Quantity_Length Aspect_Grid::YOrigin ( ) const

returns the x Origin of the grid.

Field Documentation

Quantity_Color Aspect_Grid::myColor

protected

Quantity_PlaneAngle Aspect_Grid::myRotationAngle

protected

Quantity_Color Aspect_Grid::myTenthColor

protected

Quantity_Length Aspect_Grid::myXOrigin

protected

Quantity_Length 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

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation