PoLogAxis Class Reference

Class to build a logarithmic axis. More...

#include <MeshViz/graph/PoLogAxis.h>

Inheritance diagram for PoLogAxis:

Public Types
enum	DecadeListDef {   DECADE_LIST_AUTO ,   DECADE_LIST_NON_AUTO }
	Decade list computed automatically or given by the user. More...
enum	TenPowGradRep {   TEN_POWER_POW10 ,   TEN_POWER_DECIMAL ,   TEN_POWER_AUTO }
	Type of presentation of the power of ten. More...
enum	DecadeRep {   DECADE_NONE ,   DECADE_AS_TEN_POWER ,   DECADE_DECIMAL ,   DECADE_DIGIT ,   DECADE_AUTO }
	Type of presentation of the axis decades. More...
enum	MultFactorPosition {   MULT_FACTOR_START ,   MULT_FACTOR_END ,   MULT_FACTOR_EXTR ,   MULT_FACTOR_GRAD }
	Type of position of the multiplicative factor. More...
Public Types inherited from PoCartesianAxis
enum	Type {   XY ,   XZ ,   YX ,   YZ ,   ZX ,   ZY }
	Type of axis orientation. More...
Public Types inherited from PoAxis
enum	Visibility {   VISIBILITY_OFF ,   VISIBILITY_ON ,   VISIBILITY_DEPEND }
	Enumerations. More...
enum	TextPath {   PATH_RIGHT ,   PATH_LEFT ,   PATH_UP ,   PATH_DOWN ,   PATH_DEPEND }
	Text path type. More...
enum	GradPosition {   GRAD_ABOVE ,   GRAD_BELOW ,   GRAD_DEPEND }
	Graduation position type. More...
enum	MarginType {   REL_MARGIN ,   FIXED_MARGIN }
	Margin type. More...
enum	TickPosition {   TICK_GRAD_SIDE ,   TICK_GRAD_OTHER_SIDE ,   TICK_ACROSS_AXIS }
	Tick position type. More...
enum	TitlePosition {   TITLE_MIDDLE ,   TITLE_END ,   TITLE_DEPEND }
	Title position type. More...
enum	TickSubDef {   NUM_SUB_TICK ,   PERIOD_MAIN_TICK }
	Sub-tick type. More...
enum	AxisReverse {   AXIS_NO_REVERSE ,   AXIS_REVERSE ,   AXIS_REVERSE_DEPEND }
	Axis reverse type. More...
Public Types inherited from PoBase
enum	UpdateMethodType {   UPDATE_METHOD_IMMEDIATE ,   UPDATE_METHOD_ON_ACTION }
	Type of update method. More...
enum	NodeWriteFormat {   FOLD_NODE_WRITE_FORMAT ,   UNFOLD_NODE_WRITE_FORMAT }
	Type of write format. More...
enum	TextType {   SO_TEXT3 ,   SO_ANNO_TEXT3 }
	Type of Text. More...
typedef void	PoRebuildCB(void *userData, PoBase *base)

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance.
	PoLogAxis ()
	Constructor.
	PoLogAxis (const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, DecadeListDef _decadeListDef=DECADE_LIST_AUTO, const unsigned short *_decadeList=NULL, short _numDecade=0)
	Constructor.
	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)
	Constructor.
virtual void	rebuild ()
	Forces node-kit rebuilding.
void	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	getMultFactor (MultFactorPosition &position, float &distAxis) const
	Returns the current multiplicative factor attributes (those computed can be different from the associated fields).
Public Member Functions inherited from PoAxis
void	setMiscTextAttr (PbMiscTextAttr *textAttr)
	Sets a reference to PbMiscTextAttr object for miscellaneous text attributes.
const PbMiscTextAttr *	getMiscTextAttr () const
	Gets a reference to PbMiscTextAttr object for miscellaneous text attributes.
void	getGrad (Visibility &visibility, GradPosition &position, TextPath &path, SbString &fontName, float &fontSize, float &distAxis, SbBool &addStringVisibility, SbString &addString) const
	Gets the graduations axis attributes computed by the last axis rebuilding.
void	getMargin (MarginType &type, float &start, float &end) const
	Gets the margin axis attributes computed by the last axis rebuilding.
void	getTitle (Visibility &visibility, TitlePosition &position, TextPath &path, SbString &fontName, float &fontSize, float &distAxis, SbString &string) const
	Gets the title axis attributes computed by the last axis rebuilding.
void	getGrid (Visibility &visibility, float &lengthGradSide, float &lengthGradOtherSide) const
	Gets the grid axis attributes computed by the last axis rebuilding.
void	getArrow (Visibility &visibility, float &height, float &length) const
	Gets the arrow axis attributes computed by the last axis rebuilding.
void	getTick (Visibility &visibility, TickPosition &position, float &mainLength, float &subLength, TickSubDef &def, unsigned short &numOrPeriod, unsigned short &firstGrad, unsigned short &lastGrad) const
	Gets the tick axis attributes computed by the last axis rebuilding.
AxisReverse	getReverseFlag () const
	Gets the reverse flag axis attributes computed by the last axis rebuilding.
Public Member Functions inherited from PoBase
void	setUpdateMethod (UpdateMethodType type)
	Sets scene graph update method.
UpdateMethodType	getUpdateMethod () const
	Gets update method.
void	setDomain (PbDomain *dom)
	Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
const PbDomain *	getDomain () const
	Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
void	touchKit ()
	Indicates the node kit is modified.
SbBool	isModified () const
	Return TRUE, if the kit has been modified, else otherwise.
SbBool	isBuilt () const
	Indicates if the node kit has been built at least once.
void	addPreRebuildCallback (PoRebuildCB *cb, void *data)
	Add a callback function to call when the node kit is rebuilt.
void	addPostRebuildCallback (PoRebuildCB *cb, void *data)
	Add a callback function to call when the node kit is rebuilt.
void	removePreRebuildCallback (PoRebuildCB *cb, void *data=NULL)
	Remove a callback function to call when the node kit is rebuilt.
void	removePostRebuildCallback (PoRebuildCB *cb, void *data)
	Remove a callback function to call when the node kit is rebuilt.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Copy method.
virtual SbBool	affectsState () const
	See SoNode::affectsState() for explanations.
Public Member Functions inherited from SoBaseKit
	SoBaseKit ()
	Constructor.
virtual SoNode *	getPart (const SbName &partName, SbBool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
template<typename PartType >
PartType *	getPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.
template<typename PartType >
PartType *	checkPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.
SbString	getPartString (const SoBase *part)
	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.
virtual SoNodeKitPath *	createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.
virtual SbBool	setPart (const SbName &partName, SoNode *newPart)
	Inserts the given node (not a copy) as the new part specified by partName.
SoNONUNICODE SbBool	set (char *nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.
SbBool	set (const SbString &nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.
SoNONUNICODE SbBool	set (const char *partNameString, const char *parameterString)
	This function allows field values of parts (nodes) to be set.
SbBool	set (const SbString &partNameString, const SbString &parameterString)
	This function allows field values of parts (nodes) to be set.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
Public Member Functions inherited from SoGetView
	SoGetView ()
	Default constructor.
virtual	~SoGetView ()
virtual SbBool	getViewportIsEnabled () const
	Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.
virtual const SbVec2f	getViewportOrigin () const
	Returns SbViewportRegion origin.
virtual const SbVec2f	getViewportSize () const
	Returns SbViewportRegion size.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
Static Public Member Functions inherited from PoCartesianAxis
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
Static Public Member Functions inherited from PoAxis
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
Static Public Member Functions inherited from PoBaseAxis
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
Static Public Member Functions inherited from PoGraphMaster
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
Static Public Member Functions inherited from PoBase
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.
static void	setNodeWriteFormat (NodeWriteFormat format)
	Sets the node write format.
static NodeWriteFormat	getNodeWriteFormat ()
	Gets the node write format.
static void	setTextType (TextType type)
	Sets the type of text used.
static TextType	getTextType ()
	Gets the type of text used.
static void	setVRML2Mode (SbBool flag)
	Set the VRML2 mode.
static SbBool	isVRML2Mode ()
	Gets the VRML2 mode (TRUE = VRML2 mode, FALSE Inventor mode)
Static Public Member Functions inherited from SoBaseKit
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.
static void	setSearchingChildren (SbBool newVal)
	Sets if nodekit children are searched during SoSearchAction traversal.
static SbBool	isSearchingChildren ()
	Returns TRUE if nodekit children are searched during SoSearchAction traversal.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoMFUShort	decadeList
	List of graduations between two power of ten graduations (decade graduations).
SoSFEnum	decadeListDef
	Specifies if the list of decade graduations is given by the user or is automatically computed.
SoSFEnum	tenPowerRep
	Defines the representation of power of ten graduations.
SoSFEnum	decadeRep
	Defines the representation of the decade graduations between two power of ten graduations.
SoSFString	decadeFontName
	Decade font name.
SoSFFloat	decadeFontSize
	Decade graduations font size.
SoSFEnum	multFactorPosition
	Position of the multiplicative factor.
SoSFFloat	multFactorDistAxis
	Distance from the multiplicative factor to the axis.
SoSFUShort	maxGradNum
	Maximum number of logarithmic graduations displayed.
Public Attributes inherited from PoCartesianAxis
SoSFVec3f	start
	Defines the start of the axis.
SoSFFloat	end
	Defines the end of the axis.
SoSFFloat	gradStart
	Defines the value of the graduation (tick label) corresponding to the starting coordinate of this axis.
SoSFFloat	gradEnd
	Defines the value of the graduation (tick label) corresponding to the end coordinate of this axis.
SoSFEnum	type
	Type of the axis (XY, XZ, YX, ... axis).
Public Attributes inherited from PoAxis
SoSFEnum	gradVisibility
	Graduations visibility.
SoSFEnum	gradPosition
	Graduations position.
SoSFEnum	gradPath
	Graduations path.
SoSFString	gradFontName
	Graduations font name.
SoSFFloat	gradFontSize
	Font size of the graduations.
SoSFFloat	gradDistAxis
	Distance from the graduations to the axis.
SoSFBool	gradAddStringVisibility
	Specify the visibility of a string concatenated with the graduations.
SoSFString	gradAddString
	String to be concatenated.
SoSFEnum	marginType
	Relative or absolute margin.
SoSFFloat	marginStart
	Margin at the start of the axis.
SoSFFloat	marginEnd
	Margin at the end of the axis.
SoSFEnum	titleVisibility
	Visibility of the title.
SoSFEnum	titlePosition
	Position of the title.
SoSFEnum	titlePath
	Path of the title.
SoSFString	titleFontName
	Title font name.
SoSFFloat	titleFontSize
	Font size of the title.
SoSFFloat	titleDistAxis
	Distance from the title to the axis.
SoSFString	titleString
	Title string.
SoSFEnum	gridVisibility
	Grid lines visibility.
SoSFFloat	gridLengthGradSide
	Grid lines length side graduation texts.
SoSFFloat	gridLengthGradOtherSide
	Grid lines length other side graduation texts.
SoSFEnum	arrowVisibility
	Arrow visibility.
SoSFFloat	arrowHeight
	Arrow height.
SoSFFloat	arrowLength
	Arrow length.
SoSFEnum	tickVisibility
	Tick marks visibility.
SoSFEnum	tickPosition
	Position of the tick marks.
SoSFFloat	tickMainLength
	Main graduations ticks length.
SoSFFloat	tickSubLength
	Secondary graduations ticks length.
SoSFEnum	tickSubDef
	Secondary graduations tick definition.
SoSFUShort	tickNumOrPeriod
	Number of secondary graduations (tickSubDef = NUM_SUB_TICK), or period of texts of graduations (tickSubDef = PERIOD_MAIN_TICK).
SoSFUShort	tickFirstGrad
	First graduation to display.
SoSFUShort	tickLastGrad
	Last graduation to display (number starting with the ending one).
SoSFEnum	reverseFlag
	Allow to reverse the writing path of all axis texts.
Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

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



Definition at line 110 of file PoLogAxis.h.

Member Enumeration Documentation

DecadeListDef

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.

Definition at line 129 of file PoLogAxis.h.

DecadeRep

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.

Definition at line 165 of file PoLogAxis.h.

MultFactorPosition

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.

Definition at line 199 of file PoLogAxis.h.

TenPowGradRep

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.

Definition at line 143 of file PoLogAxis.h.

Constructor & Destructor Documentation

PoLogAxis() [1/3]

PoLogAxis::PoLogAxis ( )

inline

Constructor.

Definition at line 293 of file PoLogAxis.h.

PoLogAxis() [2/3]

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.

Definition at line 300 of file PoLogAxis.h.

PoLogAxis() [3/3]

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

Definition at line 310 of file PoLogAxis.h.

Member Function Documentation

getClassNodekitCatalog()

static const SoNodekitCatalog * PoLogAxis::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

getClassTypeId()

static SoType PoLogAxis::getClassTypeId ( )

static

Returns the type identifier for this class.

getLogGrad()

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).

getMultFactor()

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

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

getNodekitCatalog()

virtual const SoNodekitCatalog * PoLogAxis::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoCartesianAxis.

getTypeId()

virtual SoType PoLogAxis::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoCartesianAxis.

rebuild()

virtual void PoLogAxis::rebuild ( )

virtual

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

Member Data Documentation

decadeFontName

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).

Definition at line 252 of file PoLogAxis.h.

decadeFontSize

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).

Definition at line 259 of file PoLogAxis.h.

decadeList

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.

Definition at line 228 of file PoLogAxis.h.

decadeListDef

SoSFEnum PoLogAxis::decadeListDef

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

Definition at line 234 of file PoLogAxis.h.

decadeRep

SoSFEnum PoLogAxis::decadeRep

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

Definition at line 246 of file PoLogAxis.h.

maxGradNum

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.

Definition at line 288 of file PoLogAxis.h.

multFactorDistAxis

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.

Definition at line 272 of file PoLogAxis.h.

multFactorPosition

SoSFEnum PoLogAxis::multFactorPosition

Position of the multiplicative factor.

Definition at line 264 of file PoLogAxis.h.

tenPowerRep

SoSFEnum PoLogAxis::tenPowerRep

Defines the representation of power of ten graduations.

Use enum TenPowGradRep.

Definition at line 240 of file PoLogAxis.h.

---

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

• MeshViz/graph/PoLogAxis.h