PoLogAxis Class Reference
[Axis]

Class to build a logarithmic axis. More...

#include <MeshViz/graph/PoLogAxis.h>

Inheritance diagram for PoLogAxis:

List of all members.

Classes
struct	Decade
struct	LogAxisAttr
struct	MultFactor
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 }
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
	PoLogAxis ()
	PoLogAxis (const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, DecadeListDef _decadeListDef=DECADE_LIST_AUTO, const unsigned short *_decadeList=NULL, short _numDecade=0)
	PoLogAxis (const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, float _gradStart, float _gradEnd, 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
void	getMultFactor (MultFactorPosition &position, float &distAxis) 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
SoSFEnum	multFactorPosition
SoSFFloat	multFactorDistAxis
SoSFUShort	maxGradNum

---

Detailed Description

Class to build a logarithmic axis.

This class builds a logarithmic axis. This axis will be generated between the point start to the point end. The graduations will be in the plane given by the user (cf type field). For instance, it can be used for building a logarithmic axis in the plane XY, with the first decade graduation being 10E3 and the last decade graduation being 10E8. Graduation values are: 10E3, 10E4, 10E5, ...,10E8): gradStart = 3, gradEnd = 8 plane = XY and maxGradNum > 8. If maxGradNum = 4, the graduations values are 10E3, 10E5 and 10E7. If the fields gradStart and gradEnd are equal, the fields start and end are used to define the graduation values.

FILE FORMAT/DEFAULT

PoLogAxis {

gradVisibility	VISILITY_DEPEND
gradPosition	GRAD_DEPEND
gradPath	PATH_DEPEND
gradFontName	""
gradFontSize	0
gradDistAxis	0
gradAddStringVisibility	FALSE
gradAddString	""
marginType	REL_MARGIN
marginStart	0
marginEnd	0
maxGradNum	10
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
type	XY
gradStart	0
gradEnd	0
decadeListDef	DECADE_LIST_AUTO
decadeList	2
tenPowerRep	TEN_POWER_POW10
decadeRep	DECADE_NONE
decadeFontName	""
decadeFontSize	0
multFactorPosition	MULT_FACTOR_END
multFactorDistAxis	0

}

CATALOG PARTS

PoLogAxis {
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.
}

Separator decadeTextSep {
Contains properties and shapes to draw decade text.
AppearanceKit decadeTextApp
Specifies the appearance of decade text. 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 PoLogAxis::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 PoLogAxis::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 PoLogAxis::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.

enum PoLogAxis::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

PoLogAxis::PoLogAxis

(

)

[inline]

Constructor.

PoLogAxis::PoLogAxis	(	const SbVec3f &	_start,
		float	_end,
		PoCartesianAxis::Type	_type,
		DecadeListDef	_decadeListDef = DECADE_LIST_AUTO,
		const unsigned short *	_decadeList = NULL,
		short	_numDecade = 0
	)			[inline]

Constructor.

PoLogAxis::PoLogAxis	(	const SbVec3f &	_start,
		float	_end,
		PoCartesianAxis::Type	_type,
		float	_gradStart,
		float	_gradEnd,
		DecadeListDef	_decadeListDef = DECADE_LIST_AUTO,
		const unsigned short *	_decadeList = NULL,
		short	_numDecade = 0
	)			[inline]

Constructor. Since Open Inventor 9.5.1

---

Member Function Documentation

static const SoNodekitCatalog* PoLogAxis::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoCartesianAxis.

static SoType PoLogAxis::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoCartesianAxis.

void PoLogAxis::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).

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

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

virtual const SoNodekitCatalog* PoLogAxis::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoCartesianAxis.

virtual SoType PoLogAxis::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoCartesianAxis.

virtual void PoLogAxis::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFString PoLogAxis::decadeFontName

Decade font name.

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

SoSFFloat PoLogAxis::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 PoLogAxis::decadeList

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 PoLogAxis::decadeListDef

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

SoSFEnum PoLogAxis::decadeRep

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

SoSFUShort PoLogAxis::maxGradNum

Maximum number of logarithmic graduations displayed.

For example, a logarithmic axis with range 0 to 100 will have 101 graduations if this value is > 100. But that would generate an axis with too many small illegible graduations. If maxGradNum is set to 10, less than 10 logarithmic graduations are displayed like 10E0, 10E10, 10E20, ... 10E90.

In order to make the axis as legible as possible, when some main logarithmic graduations are filtered out by this field, no decade graduations are displayed.

Default value is 10.

SoSFFloat PoLogAxis::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 PoLogAxis::multFactorPosition

Position of the multiplicative factor.

SoSFEnum PoLogAxis::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/PoLogAxis.h