PoAngularAxis Class Reference
[Axis]

Class to build an angular axis. More...

#include <MeshViz/graph/PoAngularAxis.h>

Inheritance diagram for PoAngularAxis:

List of all members.

Classes
struct	AngularAxisAttr
Public Types
enum	GradFit {   GRAD_FIT,   GRAD_UNFIT }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoAngularAxis ()
	PoAngularAxis (float _offset, float _startAngle, float _endAngle, float _radius, float _angleStep)
virtual void	rebuild ()
float	getAngleStep () const
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFFloat	offset
SoSFFloat	startAngle
SoSFFloat	endAngle
SoSFFloat	radius
SoSFFloat	angleStep
SoSFEnum	gradFit

---

Detailed Description

Class to build an angular axis.

This class builds an angular axis in the plane XY. The axis is generated between (startAngle + offset) and (endEngle + offset) in counter-clockwise. It is centered at (0,0). An angle step defines the angular distance between two graduations. Graduations are displayed in degrees. The inherited field reverseFlag is not used.

CATALOG PARTS

PoAngularAxis {

Separator alternateRep (from PoBase) {

AppearanceKit appearance (from PoBase)

Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.

MatrixTransform domainTransform (from PoBase)

Corresponds to the domain transformation.

MatrixTransform transform (from PoAxis)

Not used.

Separator bodySep (from PoAxis) {

Contains properties and shapes to draw the body of the axis.

AppearanceKit bodyApp (from PoAxis)

Specifies the appearance of the body of the axis.

Group body (from PoAxis)

Contains a SoLineSet shape to draw the body of the axis.

}

Separator arrowSep (from PoAxis) {

Contains properties and shapes to draw the arrow.

AppearanceKit arrowApp (from PoAxis)

Specifies the appearance of the arrow.

Group arrow (from PoAxis)

Contains a SoFaceSet shape to draw the arrow.

}

Separator subGradTickSep (from PoAxis) {

Contains properties and shapes to draw sub-graduation tick.

AppearanceKit subGradTickApp (from PoAxis)

Specifies the appearance of sub-graduation tick.

Group subGradTick (from PoAxis)

Contains a SoLineSet shape to draw sub-graduation tick.

}

Separator subGradGridSep (from PoAxis){

Contains properties and shapes to draw sub-graduation grid.

AppearanceKit subGradGridApp (from PoAxis)

Specifies the appearance of sub-graduation grid.

Group subGradGrid (from PoAxis)

Contains a SoLineSet shape to draw sub-graduation grid.

}

Separator mainGradTickSep (from PoAxis){

Contains properties and shapes to draw main-graduation tick.

AppearanceKit mainGradTickApp (from PoAxis)

Specifies the appearance of main-graduation tick.

Group mainGradTick (from PoAxis)

Contains a SoLineSet shape to draw main-graduation tick.

}

Separator mainGradGridSep (from PoAxis){

Contains properties and shapes to draw main-graduation grid.

AppearanceKit mainGradGridApp (from PoAxis)

Specifies the appearance of main-graduation grid.

Group mainGradGrid (from PoAxis)

Contains a SoLineSet shape to draw main-graduation grid.

}

Separator mainGradTextSep (from PoAxis) {

Contains properties and shapes to draw main-graduation text.

AppearanceKit mainGradTextApp (from PoAxis)

Specifies the appearance of main-graduation text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.

Group mainGradText (from PoAxis)

Contains a list of SoAnnoText3 shapes to draw main-graduation text.

}

Separator titleSep (from PoAxis) {

Contains properties and shapes to draw title text.

AppearanceKit titleApp (from PoAxis)

Specifies the appearance of title text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.

Group title (from PoAxis)

Contains a SoAnnoText3 shape to draw title.

}

}

}

---

Member Enumeration Documentation

enum PoAngularAxis::GradFit

Enumerations.

First graduation rounded or not.

Enumerator:

GRAD_FIT	The first graduation is rounded.
GRAD_UNFIT	The first graduation is not rounded.

---

Constructor & Destructor Documentation

PoAngularAxis::PoAngularAxis

(

)

Default constructor.

PoAngularAxis::PoAngularAxis	(	float	_offset,
		float	_startAngle,
		float	_endAngle,
		float	_radius,
		float	_angleStep
	)			[inline]

Constructor.

---

Member Function Documentation

float PoAngularAxis::getAngleStep

(

)

const

Returns the current angle step (the step computed can be different from the associated field).

static const SoNodekitCatalog* PoAngularAxis::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoAxis.

static SoType PoAngularAxis::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoAxis.

virtual const SoNodekitCatalog* PoAngularAxis::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoAxis.

virtual SoType PoAngularAxis::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoAxis.

virtual void PoAngularAxis::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFFloat PoAngularAxis::angleStep

Angular distance in radians between two graduations.

If this value is <= 0, the angle step is automatically calculated according to the ratio radius and the current domain (see PoBase description).

SoSFFloat PoAngularAxis::endAngle

Angle in radians of the end of the axis.

SoSFEnum PoAngularAxis::gradFit

This flag indicates if the first graduation is rounded or not.

(GRAD_UNFIT by default).

SoSFFloat PoAngularAxis::offset

Offset for the axis in radians.

(However the graduations begin at startAngle to endAngle).

SoSFFloat PoAngularAxis::radius

Radius of the axis.

SoSFFloat PoAngularAxis::startAngle

Angle in radians of the origin of the axis.

---

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

• MeshViz/graph/PoAngularAxis.h