PoPolarAxis Class Reference
[Axis]

Abstract class for polar axis. More...

#include <MeshViz/graph/PoPolarAxis.h>

Inheritance diagram for PoPolarAxis:

List of all members.

Classes
struct	MultFactor
struct	PolarAxisAttr
Public Types
enum	MultFactorPosition {   MULT_FACTOR_START,   MULT_FACTOR_END,   MULT_FACTOR_EXTR,   MULT_FACTOR_GRAD }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
void	getMultFactor (MultFactorPosition &position, float &distAxis) const
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFFloat	offset
SoSFFloat	startRadius
SoSFFloat	endRadius
SoSFFloat	theta
SoSFEnum	multFactorPosition
SoSFFloat	multFactorDistAxis

---

Detailed Description

Abstract class for polar axis.

Abstract class for polar axes. This class handles the offset, start radius, end radius and the rotation angle theta of polar axis. The inherited fields gridLengthGradSide and gridLengthGradOtherSide are expressed in radians (grid lines are arcs of circle).

---

Member Enumeration Documentation

enum PoPolarAxis::MultFactorPosition

Type of position of the multiplicative factor.

Enumerator:

MULT_FACTOR_START	The multiplicative factor is at the start of the axis.
MULT_FACTOR_END	The multiplicative factor is at the end of the axis.
MULT_FACTOR_EXTR	The multiplicative factor is at the start and at the end of the axis.
MULT_FACTOR_GRAD	The multiplicative factor is at the graduations of the axis.

---

Member Function Documentation

static const SoNodekitCatalog* PoPolarAxis::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoAxis.

Reimplemented in PoPolarLinAxis, and PoPolarLogAxis.

static SoType PoPolarAxis::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoAxis.

Reimplemented in PoPolarLinAxis, and PoPolarLogAxis.

void PoPolarAxis::getMultFactor	(	MultFactorPosition &	position,
		float &	distAxis
	)			const

Returns the current multiplicative factor attributes (those computed can be different from the associated fields).

virtual const SoNodekitCatalog* PoPolarAxis::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoAxis.

Reimplemented in PoPolarLinAxis, and PoPolarLogAxis.

virtual SoType PoPolarAxis::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoAxis.

Reimplemented in PoPolarLinAxis, and PoPolarLogAxis.

---

Member Data Documentation

SoSFFloat PoPolarAxis::endRadius

Radius at the end of the axis.

SoSFFloat PoPolarAxis::multFactorDistAxis

Distance from the mutiplicative factor to the axis.

This value is a percentage of the current domain (cf PoBase description). If this value is <= 0, the distance is automatically calculated.

SoSFEnum PoPolarAxis::multFactorPosition

Position of the multiplicative factor.

SoSFFloat PoPolarAxis::offset

Offset for the axis.

SoSFFloat PoPolarAxis::startRadius

Radius at the start of the axis.

SoSFFloat PoPolarAxis::theta

Rotation angle of the axis in radians.

---

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

• MeshViz/graph/PoPolarAxis.h