Aspect_Grid Class Reference

#include <Aspect_Grid.hxx>

Inheritance diagram for Aspect_Grid:

Public Member Functions
void	SetXOrigin (const Quantity_Length anOrigin)
	defines the x Origin of the grid.
void	SetYOrigin (const Quantity_Length anOrigin)
	defines the y Origin of the grid.
void	SetRotationAngle (const Quantity_PlaneAngle anAngle)
	defines the orientation of the the grid.
void	Rotate (const Quantity_PlaneAngle anAngle)
	Rotate the grid from a relative angle.
void	Translate (const Quantity_Length aDx, const Quantity_Length 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 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	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
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.
Quantity_Length	XOrigin () const
	returns the x Origin of the grid.
Quantity_Length	YOrigin () const
	returns the x Origin of the grid.
Quantity_PlaneAngle	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 ()
	Display the grid at screen.
virtual void	Erase () const
	Erase the grid from screen.
virtual Standard_Boolean	IsDisplayed () const
	Returns TRUE when the grid is displayed at screen.
virtual void	Init ()=0
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.
virtual void	UpdateDisplay ()
	Updates the grid parameters.
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]

---

Member Function Documentation

void Aspect_Grid::Activate

(

)

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

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

Implemented in Aspect_RectangularGrid, and Aspect_CircularGrid.

void Aspect_Grid::Deactivate

(

)

virtual void Aspect_Grid::Display

(

)

[virtual]

Reimplemented in V3d_CircularGrid, V3d_RectangularGrid, V2d_RectangularGrid, and V2d_CircularGrid.

Aspect_GridDrawMode Aspect_Grid::DrawMode

(

)

const

virtual void Aspect_Grid::Erase

(

)

const [virtual]

Reimplemented in V3d_CircularGrid, V3d_RectangularGrid, V2d_RectangularGrid, and V2d_CircularGrid.

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

virtual void Aspect_Grid::Init

(

)

[pure virtual]

Implemented in Aspect_RectangularGrid, and Aspect_CircularGrid.

Standard_Boolean Aspect_Grid::IsActive

(

)

const

virtual Standard_Boolean Aspect_Grid::IsDisplayed

(

)

const [virtual]

Reimplemented in V3d_CircularGrid, V3d_RectangularGrid, V2d_RectangularGrid, and V2d_CircularGrid.

void Aspect_Grid::Rotate

(

const Quantity_PlaneAngle

anAngle

)

Quantity_PlaneAngle Aspect_Grid::RotationAngle

(

)

const

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

Reimplemented in V3d_CircularGrid, and V3d_RectangularGrid.

void Aspect_Grid::SetDrawMode

(

const Aspect_GridDrawMode

aDrawMode

)

void Aspect_Grid::SetRotationAngle

(

const Quantity_PlaneAngle

anAngle

)

void Aspect_Grid::SetXOrigin

(

const Quantity_Length

anOrigin

)

void Aspect_Grid::SetYOrigin

(

const Quantity_Length

anOrigin

)

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

virtual void Aspect_Grid::UpdateDisplay

(

)

[protected, virtual]

Reimplemented in V3d_CircularGrid, V3d_RectangularGrid, V2d_RectangularGrid, and V2d_CircularGrid.

Quantity_Length Aspect_Grid::XOrigin

(

)

const

Quantity_Length Aspect_Grid::YOrigin

(

)

const

---

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