PoPolarLogAxis Class Reference
[Axis]

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

#include <MeshViz/graph/PoPolarLogAxis.h>

Inheritance diagram for PoPolarLogAxis:

List of all members.

Classes
struct	Decade
struct	PolLogAxisAttr
Public Types
enum	DecadeListDef {   DECADE_LIST_AUTO,   DECADE_LIST_NON_AUTO }
enum	TenPowGradRep {   TEN_POWER_POW10,   TEN_POWER_DECIMAL,   TEN_POWER_AUTO }
enum	DecadeRep {   DECADE_NONE,   DECADE_AS_TEN_POWER,   DECADE_DECIMAL,   DECADE_DIGIT,   DECADE_AUTO }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoPolarLogAxis ()
	PoPolarLogAxis (float offset, float startRadius, float endRadius, float theta, DecadeListDef decadeListDef=DECADE_LIST_AUTO, const unsigned short *decadeList=NULL, short numDecade=0)
virtual void	rebuild ()
void	getLogGrad (unsigned short &numDecade, unsigned short decadeList[8], TenPowGradRep &tenPowerRep, DecadeRep &decadeRep, SbString &decadeFontName, float &decadeFontSize) const
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoMFUShort	decadeList
SoSFEnum	decadeListDef
SoSFEnum	tenPowerRep
SoSFEnum	decadeRep
SoSFString	decadeFontName
SoSFFloat	decadeFontSize

---

Detailed Description

Class to build a logarithmic polar axis.

This class builds a polar logarithmic axis in the plane XY. This axis will be generated from the point in polar coordinates (startRadius - offset, theta) to the point (endRadius - offset, theta), however the graduations start at startRadius and finish at endRadius. For instance to build a polar logarithmic axis with the first decade graduation being 103 and the last decade graduation being 10E8 (graduation values are: 10E3, 10E4, 10E5, ...,10E8): startRadius = 3 endRadius = 8.

FILE FORMAT/DEFAULT

PoPolarLogAxis {

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
decadeListDef	DECADE_LIST_AUTO
decadeList	2
tenPowerRep	TEN_POWER_POW10
decadeRep	DECADE_NONE
decadeFontName	""
decadeFontSize	0

}

CATALOG PARTS

PoPolarLogAxis {
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 to the start.
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.
}

Separator decadeTextSep {
Contains properties and shapes to draw decade text.
AppearanceKit decadeTextApp
Specifies the appearance of multiplicative factor. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.
Group decadeText
Contains a list of SoAnnoText3 shape to draw decade text.
}
}
}



---

Member Enumeration Documentation

enum PoPolarLogAxis::DecadeListDef

Decade list computed automatically or given by the user.

Enumerator:

DECADE_LIST_AUTO	The list of decade graduations is automatically computed.
DECADE_LIST_NON_AUTO	The list of decade graduations is given by the user.

enum PoPolarLogAxis::DecadeRep

Type of presentation of the axis decades.

Enumerator:

DECADE_NONE	No decade graduations are displayed.
DECADE_AS_TEN_POWER	Decade graduations are displayed as power of ten graduations.
DECADE_DECIMAL	Decade graduations are displayed in decimals.
DECADE_DIGIT	Decade graduations are displayed using a digit from 2 to 9.
DECADE_AUTO	giving the multiple of the power of ten. Automatic mode, one of the three previous type is used depending on the axis range.

enum PoPolarLogAxis::TenPowGradRep

Type of presentation of the power of ten.

Enumerator:

TEN_POWER_POW10	The graduations are specified in powers of ten.
TEN_POWER_DECIMAL	The graduations are specified in decimals.
TEN_POWER_AUTO	The graduations are specified in powers of ten or in decimals,. depending on the axis range.

---

Constructor & Destructor Documentation

PoPolarLogAxis::PoPolarLogAxis

(

)

Default constructor.

PoPolarLogAxis::PoPolarLogAxis	(	float	offset,
		float	startRadius,
		float	endRadius,
		float	theta,
		DecadeListDef	decadeListDef = DECADE_LIST_AUTO,
		const unsigned short *	decadeList = NULL,
		short	numDecade = 0
	)

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoPolarLogAxis::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoPolarAxis.

static SoType PoPolarLogAxis::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoPolarAxis.

void PoPolarLogAxis::getLogGrad	(	unsigned short &	numDecade,
		unsigned short	decadeList[8],
		TenPowGradRep &	tenPowerRep,
		DecadeRep &	decadeRep,
		SbString &	decadeFontName,
		float &	decadeFontSize
	)			const

Returns the current logarithmic graduations attributes (those computed can be different from the associated fields).

virtual const SoNodekitCatalog* PoPolarLogAxis::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoPolarAxis.

virtual SoType PoPolarLogAxis::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoPolarAxis.

virtual void PoPolarLogAxis::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFString PoPolarLogAxis::decadeFontName

Decade font name.

If the font is equal to its default value, the font used is the font of the the current miscellaneous text attributes (cf PoAxis description).

SoSFFloat PoPolarLogAxis::decadeFontSize

Decade graduations font size.

If this value is <= 0, the font size is fixed at 0.04 if the graduations do not cross each other. This value is a percentage of the current domain (cf PoBase description).

SoMFUShort PoPolarLogAxis::decadeList

Specifies if the list of decade graduations is given by the user or is automatically computed.

SoSFEnum PoPolarLogAxis::decadeListDef

List of graduations between two power of ten graduations (decade graduations).

For each integer value i of decadeList, 2 <= i <= 9, only the 8 first values of decadeList are used. This field is used to build the axis only if decadeListDef = DECADE_LIST_NON_AUTO.

SoSFEnum PoPolarLogAxis::decadeRep

Defines the representation of the decade graduations between two power of ten graduations.

SoSFEnum PoPolarLogAxis::tenPowerRep

Defines the representation of power of ten graduations.

Use enum TenPowGradRep.

---

The documentation for this class was generated from the following file:
• MeshViz/graph/PoPolarLogAxis.h