PoPolarLinAxis Class Reference
[Axis]

Class to build a polar linear axis. More...

#include <MeshViz/graph/PoPolarLinAxis.h>

Inheritance diagram for PoPolarLinAxis:

List of all members.

Classes
struct	PolarLinAxisAttr
Public Types
enum	GradFit {   GRAD_FIT,   GRAD_UNFIT }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoPolarLinAxis ()
	PoPolarLinAxis (float offset, float startRadius, float endRadius, float theta, float step=0.0)
virtual void	rebuild ()
void	setFormat (PbNumericDisplayFormat *format)
const PbNumericDisplayFormat *	getFormat () const
float	getStep () const
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFFloat	step
SoSFEnum	gradFit

---

Detailed Description

Class to build a polar linear axis.

This class builds a polar linear axis in the plane XY. This axis will be generated from the point in polar coordinate (startRadius + offset, theta) to the point (endRadius + offset, theta), however the graduations start at startRadius and finish at endRadius.

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 current numerical display format is specified in the current inherited state (cf property node PoNumericDisplayFormat).

FILE FORMAT/DEFAULT

PoPolarLinAxis {

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
offset	0
startRadius	0
endRadius	1
theta	0
multFactorPosition	MULT_FACTOR_END
multFactorDistAxis	0
step	0
gradFit	GRAD_UNFIT

}

CATALOG PARTS

PoPolarLinAxis {
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 (from PoPolarAxis) {
Contains properties and shapes to draw multiplicative factor.
AppearanceKit multFactorApp (from PoPolarAxis)
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 (from PoPolarAxis)
Contains a list of SoAnnoText3 shape to draw multiplicative factor.
}
}
}



---

Member Enumeration Documentation

enum PoPolarLinAxis::GradFit

First graduation rounded or not.

Enumerator:

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

---

Constructor & Destructor Documentation

PoPolarLinAxis::PoPolarLinAxis

(

)

Default constructor.

PoPolarLinAxis::PoPolarLinAxis	(	float	offset,
		float	startRadius,
		float	endRadius,
		float	theta,
		float	step = 0.0
	)

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoPolarLinAxis::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoPolarAxis.

static SoType PoPolarLinAxis::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoPolarAxis.

const PbNumericDisplayFormat* PoPolarLinAxis::getFormat

(

)

const

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

virtual const SoNodekitCatalog* PoPolarLinAxis::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoPolarAxis.

float PoPolarLinAxis::getStep

(

)

const

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

virtual SoType PoPolarLinAxis::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoPolarAxis.

virtual void PoPolarLinAxis::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

void PoPolarLinAxis::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), this is the numerical display format defined in the current inherited state (defined with the property node PoNumericDisplayFormat) which is used.

---

Member Data Documentation

SoSFEnum PoPolarLinAxis::gradFit

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

SoSFFloat PoPolarLinAxis::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/PoPolarLinAxis.h