PoLinearAxis Class Reference
[Axis]

Class to build a linear axis. More...

#include <MeshViz/graph/PoLinearAxis.h>

Inheritance diagram for PoLinearAxis:

List of all members.

Classes
struct	LinAxisAttr
struct	MultFactor
Public Types
enum	GradFit {   GRAD_FIT,   GRAD_UNFIT }
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
	PoLinearAxis ()
	PoLinearAxis (const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, float _step=0.0)
	PoLinearAxis (const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, float _gradStart, float _gradEnd, float _step=0.0)
virtual void	rebuild ()
void	setFormat (PbNumericDisplayFormat *format)
const PbNumericDisplayFormat *	getFormat () const
float	getStep () const
void	getMultFactor (MultFactorPosition &position, float &distAxis) const
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFFloat	step
SoSFEnum	gradFit
SoSFEnum	multFactorPosition
SoSFFloat	multFactorDistAxis

---

Detailed Description

Class to build a linear axis.

This class builds a linear axis. This axis will be generated between the point start and the point end. The graduations (tick marks, labels, etc) will be in the plane given by the field PoCartesianAxis::type.

By default, the text of the displayed graduations (the tick mark labels) are based on the actual coordinates of the axis (start and end). The text of the graduations is based on the specified range if the gradStart and gradEnd fields are not equal.

The graduations format depends on the current numerical display format. If the method setFormat(format) is called, the current numerical display format is "format". Otherwise the numerical display format is the inherited value from PoNumericDisplayFormat (default AUTO).

See PoAxis for discussion of axis attributes.

Axis Attributes

Many other kinds of axes can generated, for example:

• Log axis (PoLogAxis)
• Time axis (PoTimeAxis)
• General non-numeric axis (PoGenAxis)
• Polar axis (PoPolarLinAxis, PoPolarLogAxis)

Multiple axes can generated conveniently using PoGroup2Axis, etc.

FILE FORMAT/DEFAULT

PoLinearAxis {

gradVisibility	VISILITY_DEPEND
gradPosition	GRAD_DEPEND
gradPath	PATH_DEPEND
gradFontName	""
gradFontSize	0
gradDistAxis	0
gradAddStringVisibility	FALSE
gradAddString	""
marginType	REL_MARGIN
marginStart	0
marginEnd	0
titleVisibility	VISILITY_DEPEND
titlePosition	TITLE_DEPEND
titlePath	PATH_DEPEND
titleFontName	""
titleFontSize	0
titleDistAxis	0
titleString	""
gridVisibility	VISILITY_DEPEND
gridLengthGradSide	0
gridLengthGradOtherSide	1
arrowVisibility	VISIBILITY_DEPEND
arrowHeight	0.03
arrowLength	0.05
tickVisibility	VISIBILITY_DEPEND
tickPosition	TICK_GRAD_SIDE
tickMainLength	0
tickSubLength	0
tickSubDef	PERIOD_MAIN_TICK
tickNumOrPeriod	1
tickFirstGrad	1
tickLastGrad	1
reverseFlag	AXIS_REVERSE_DEPEND
start	0 0 0
end	1
gradStart	0
gradEnd	0
type	XY
step	0
gradFit	GRAD_UNFIT
multFactorPosition	MULT_FACTOR_END
multFactorDistAxis	0

}

SEE ALSO

PoGenAxis, PoLogAxis, PoLogAxis, PoTimeAxis, PoPolarLinAxis, PoPolarLogAxis

CATALOG PARTS

PoLinearAxis {

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)

Corresponds to the axis plane orientation matrix.

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.

}

Separator multFactorSep {

Contains properties and shapes to draw multiplicative factor.

AppearanceKit multFactorApp

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

Group multFactor

Contains a list of SoAnnoText3 shape to draw multiplicative factor.

}

}

}

See related examples:

MedicalSimpleVolumeAxis

---

Member Enumeration Documentation

enum PoLinearAxis::GradFit

First graduation rounded or not.

Enumerator:

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

enum PoLinearAxis::MultFactorPosition

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.

---

Constructor & Destructor Documentation

PoLinearAxis::PoLinearAxis

(

)

[inline]

Default constructor.

PoLinearAxis::PoLinearAxis	(	const SbVec3f &	_start,
		float	_end,
		PoCartesianAxis::Type	_type,
		float	_step = 0.0
	)			[inline]

Constructor.

PoLinearAxis::PoLinearAxis	(	const SbVec3f &	_start,
		float	_end,
		PoCartesianAxis::Type	_type,
		float	_gradStart,
		float	_gradEnd,
		float	_step = 0.0
	)			[inline]

Constructor. Since Open Inventor 9.3

---

Member Function Documentation

static const SoNodekitCatalog* PoLinearAxis::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoCartesianAxis.

static SoType PoLinearAxis::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoCartesianAxis.

const PbNumericDisplayFormat* PoLinearAxis::getFormat

(

)

const

Gets a reference to the PbNumericDisplayFormat object for the numerical display format for the graduations.

Returns null if none specified.

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

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

virtual const SoNodekitCatalog* PoLinearAxis::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoCartesianAxis.

float PoLinearAxis::getStep

(

)

const

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

virtual SoType PoLinearAxis::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoCartesianAxis.

virtual void PoLinearAxis::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

void PoLinearAxis::setFormat

(

PbNumericDisplayFormat *

format

)

Sets a reference to a PbNumericDisplayFormat object for the numerical display format for the graduations.

If this method is not called (or called passing NULL as argument), the numerical display format defined in the current inherited state (defined with the property node PoNumericDisplayFormat) is used.

---

Member Data Documentation

SoSFEnum PoLinearAxis::gradFit

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

SoSFFloat PoLinearAxis::multFactorDistAxis

Distance from the multiplicative 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 PoLinearAxis::multFactorPosition

Position of the multiplicative factor.

SoSFFloat PoLinearAxis::step

Defines the step for the axis.

If this value is <= 0, the step is automatically calculated.

---

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

• MeshViz/graph/PoLinearAxis.h