SoAxis Class Reference

#include <SoAxis.h>

Inheritance diagram for SoAxis:

Public Member Functions
	SoAxis ()
	Constructor.
void	generatePrimitives (SoAction *) override
	Action behaviour to be implemented.
void	GLRender (SoGLRenderAction *action) override
void	computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center) override

Static Public Member Functions
static void	initClass ()
	Initializes this class.

Public Attributes
SoSFTrigger	adjustSettings
	If this field is triggered then the current axisVolumeSize field is used to set a sensible axis setting from it.
SoSFBool	autoAdjustSettings
	If TRUE all changes of the node automatically cause setting of sensible axis settings from it.
SoSFBool	axisOn
	Enables/disables drawing of the coordinate system. Default is True.
SoSFVec3f	axisVolumeSize
	Field which is used as volume size input.
SoSFUInt32	axisFontSize
	Selects fonts size for axis annotation. Default is 0.
SoSFBool	axis1Visibility
	Enables/Disables visibility of axis 1. Default is True.
SoSFBool	axis2Visibility
	Enables/Disables visibility of axis 2. Default is True.
SoSFBool	axis3Visibility
	Enables/Disables visibility of axis 3. Default is True.
SoSFBool	axisNumberingOn
	Enables/Disables numbering of axis ticks. Default is True.
SoSFBool	axisSubTickingOn
	Enables/Disables drawing of subticks. Default is True.
SoSFVec3f	axisStepSizes
	Determines distances between axis ticks. Default is (1,1,1).
SoSFVec3f	axisOrigin
	The world position of the axis origin. Default is (0,0,0).
SoSFVec3f	axisMinEnds
	The start values foer each axis. Default is (-1,-1,-1).
SoSFVec3f	axisMaxEnds
	The end values of each axis. Default is (1,1,1).
SoSFVec3f	axisMarkerLength
	The size of the axis ticks. Default is (0,0,0).
SoSFVec3f	axisTicksMin
	Position of the first axis tick. Default is (0,0,0).
SoSFVec3f	axisTicksMax
	Position of the last axis tick. Default is (1,1,1).
SoSFVec3f	axisNumBias
	Values to be added to axis numbers. Default is (0,0,0).
SoSFVec3f	axisNumScale
	Axis numbers are multiplied with these values. Default is (1,1,1).
SoSFBool	boxOn
	Enables/disables box drawing. Default is False.
SoSFVec3f	axisWingLength
	Size the arrows at the end of each axis. Defaut is (0.5, 0.5, 0.5).
SoSFVec3f	axisOverScale
	Factor which makes the axis longer to be sure that arrows are not at position of last tick.
SoSFVec3f	axisSubTickSteps
	Subdivision of distance between ticks to determine smaller ticks between.
SoSFVec3f	axisSubTickScales
	Tick lengthes multiplied with this scale factors result to size of subticks.
SoSFMLImage	inputImage
	Pointer to input image field.
Enables/Disables drawing of tick sized grids in the corresponding planes. Defaults are False.
SoSFBool	multiAxisXY
SoSFBool	multiAxisXZ
SoSFBool	multiAxisYX
SoSFBool	multiAxisYZ
SoSFBool	multiAxisZX
SoSFBool	multiAxisZY
SoSFString	axis1Text
	Text to be drawn at axis ends.
SoSFString	axis2Text
SoSFString	axis3Text
SoSFString	numPrefix1Text
	Text to be inserted/appended before/after axis numberings, defaults are "".
SoSFString	numPrefix2Text
SoSFString	numPrefix3Text
SoSFString	numPostfix1Text
SoSFString	numPostfix2Text
SoSFString	numPostfix3Text
SoSFEnum	axisText1AlignMode
	Type selector for text alignments, default is TEXT_ALIGN_LEFT.
SoSFEnum	axisText2AlignMode
SoSFEnum	axisText3AlignMode
SoSFEnum	axisNumber1AlignMode
SoSFEnum	axisNumber2AlignMode
SoSFEnum	axisNumber3AlignMode
Color and transparency of axis 1 and its (sub)ticks. Defaults are
SoSFColor	axis1Color
SoSFFloat	axis1Transparency
Color and transparency of axis 2 and its (sub)ticks. Defaults are
SoSFColor	axis2Color
SoSFFloat	axis2Transparency
Color and transparency of axis 3 and its (sub)ticks. Defaults are
SoSFColor	axis3Color
SoSFFloat	axis3Transparency
Defines color of box (if drawn). Defaults are
SoSFColor	boxColor
SoSFFloat	boxTransparency

Protected Member Functions
	~SoAxis () override
	Destructor.
virtual void	_adjustSettings ()
	Adjust all settings to volume size field.
void	_triggerChanged (SoField *field)
	Method called by _fieldChangedCB when the trigger field is changed.
void	_autoAdjustSettingsChanged (SoField *field)
	called if autoAdjustSettings or axisVolumeSize changes:
void	_inputImageChanged (SoField *field)
	called if inputImage changes:
void	drawBox ()
	Draw the box.

Protected Attributes
Axis	_axis
	Instance of Axis for drawing.
SbString	_text1
	Text buffer for axis title text.
SbString	_text2
SbString	_text3
SbString	_numPrefix1
	Prefixes and postfixes for axis numbers; also highly useful to format number locations next to axis.
SbString	_numPrefix2
SbString	_numPrefix3
SbString	_numPostfix1
SbString	_numPostfix2
SbString	_numPostfix3

Detailed Description

Definition at line 44 of file SoAxis.h.

Constructor & Destructor Documentation

SoAxis()

SoAxis::SoAxis

(

)

Constructor.

~SoAxis()

SoAxis::~SoAxis ( )

overrideprotected

Destructor.

Member Function Documentation

_adjustSettings()

virtual void SoAxis::_adjustSettings ( )

protectedvirtual

Adjust all settings to volume size field.

_autoAdjustSettingsChanged()

void SoAxis::_autoAdjustSettingsChanged ( SoField * field )

protected

called if autoAdjustSettings or axisVolumeSize changes:

_inputImageChanged()

void SoAxis::_inputImageChanged ( SoField * field )

protected

called if inputImage changes:

_triggerChanged()

void SoAxis::_triggerChanged ( SoField * field )

protected

Method called by _fieldChangedCB when the trigger field is changed.

computeBBox()

void SoAxis::computeBBox ( SoAction * action, SbBox3f & box, SbVec3f & center )

override

drawBox()

void SoAxis::drawBox ( )

protected

Draw the box.

generatePrimitives()

void SoAxis::generatePrimitives ( SoAction * )

inlineoverride

Action behaviour to be implemented.

Definition at line 206 of file SoAxis.h.

GLRender()

void SoAxis::GLRender ( SoGLRenderAction * action )

override

initClass()

static void SoAxis::initClass ( )

static

Initializes this class.

Member Data Documentation

_axis

Axis SoAxis::_axis

protected

Instance of Axis for drawing.

Definition at line 234 of file SoAxis.h.

_numPostfix1

SbString SoAxis::_numPostfix1

protected

Definition at line 245 of file SoAxis.h.

_numPostfix2

SbString SoAxis::_numPostfix2

protected

Definition at line 245 of file SoAxis.h.

_numPostfix3

SbString SoAxis::_numPostfix3

protected

Definition at line 245 of file SoAxis.h.

_numPrefix1

SbString SoAxis::_numPrefix1

protected

Prefixes and postfixes for axis numbers; also highly useful to format number locations next to axis.

Definition at line 244 of file SoAxis.h.

_numPrefix2

SbString SoAxis::_numPrefix2

protected

Definition at line 244 of file SoAxis.h.

_numPrefix3

SbString SoAxis::_numPrefix3

protected

Definition at line 244 of file SoAxis.h.

_text1

SbString SoAxis::_text1

protected

Text buffer for axis title text.

Definition at line 238 of file SoAxis.h.

_text2

SbString SoAxis::_text2

protected

Definition at line 238 of file SoAxis.h.

_text3

SbString SoAxis::_text3

protected

Definition at line 238 of file SoAxis.h.

adjustSettings

SoSFTrigger SoAxis::adjustSettings

If this field is triggered then the current axisVolumeSize field is used to set a sensible axis setting from it.

So determination of tick steps etc. are done automatically. For more details see autoAdjustSettings.

Definition at line 55 of file SoAxis.h.

autoAdjustSettings

SoSFBool SoAxis::autoAdjustSettings

If TRUE all changes of the node automatically cause setting of sensible axis settings from it.

So determination of tick steps etc. are done automatically. In case of adjustment the fields axisMinEnds, axisMaxEnds, axisTicksMin, axisTicksMax, axisStepSizes, axisMarkerLength, axisWingLength, axisSubTickSteps and axisSubTickScales are adapted. Default is True.

Definition at line 63 of file SoAxis.h.

axis1Color

SoSFColor SoAxis::axis1Color

Definition at line 158 of file SoAxis.h.

axis1Text

SoSFString SoAxis::axis1Text

Text to be drawn at axis ends.

Defaults are "X", "Y", and "Z".

Definition at line 103 of file SoAxis.h.

axis1Transparency

SoSFFloat SoAxis::axis1Transparency

Definition at line 159 of file SoAxis.h.

axis1Visibility

SoSFBool SoAxis::axis1Visibility

Enables/Disables visibility of axis 1. Default is True.

Definition at line 77 of file SoAxis.h.

axis2Color

SoSFColor SoAxis::axis2Color

Definition at line 165 of file SoAxis.h.

axis2Text

SoSFString SoAxis::axis2Text

Definition at line 104 of file SoAxis.h.

axis2Transparency

SoSFFloat SoAxis::axis2Transparency

Definition at line 166 of file SoAxis.h.

axis2Visibility

SoSFBool SoAxis::axis2Visibility

Enables/Disables visibility of axis 2. Default is True.

Definition at line 80 of file SoAxis.h.

axis3Color

SoSFColor SoAxis::axis3Color

Definition at line 172 of file SoAxis.h.

axis3Text

SoSFString SoAxis::axis3Text

Definition at line 105 of file SoAxis.h.

axis3Transparency

SoSFFloat SoAxis::axis3Transparency

Definition at line 173 of file SoAxis.h.

axis3Visibility

SoSFBool SoAxis::axis3Visibility

Enables/Disables visibility of axis 3. Default is True.

Definition at line 83 of file SoAxis.h.

axisFontSize

SoSFUInt32 SoAxis::axisFontSize

Selects fonts size for axis annotation. Default is 0.

Definition at line 74 of file SoAxis.h.

axisMarkerLength

SoSFVec3f SoAxis::axisMarkerLength

The size of the axis ticks. Default is (0,0,0).

Definition at line 141 of file SoAxis.h.

axisMaxEnds

SoSFVec3f SoAxis::axisMaxEnds

The end values of each axis. Default is (1,1,1).

Definition at line 138 of file SoAxis.h.

axisMinEnds

SoSFVec3f SoAxis::axisMinEnds

The start values foer each axis. Default is (-1,-1,-1).

Definition at line 135 of file SoAxis.h.

axisNumber1AlignMode

SoSFEnum SoAxis::axisNumber1AlignMode

Definition at line 123 of file SoAxis.h.

axisNumber2AlignMode

SoSFEnum SoAxis::axisNumber2AlignMode

Definition at line 124 of file SoAxis.h.

axisNumber3AlignMode

SoSFEnum SoAxis::axisNumber3AlignMode

Definition at line 125 of file SoAxis.h.

axisNumberingOn

SoSFBool SoAxis::axisNumberingOn

Enables/Disables numbering of axis ticks. Default is True.

Definition at line 86 of file SoAxis.h.

axisNumBias

SoSFVec3f SoAxis::axisNumBias

Values to be added to axis numbers. Default is (0,0,0).

Definition at line 150 of file SoAxis.h.

axisNumScale

SoSFVec3f SoAxis::axisNumScale

Axis numbers are multiplied with these values. Default is (1,1,1).

Definition at line 153 of file SoAxis.h.

axisOn

SoSFBool SoAxis::axisOn

Enables/disables drawing of the coordinate system. Default is True.

Definition at line 66 of file SoAxis.h.

axisOrigin

SoSFVec3f SoAxis::axisOrigin

The world position of the axis origin. Default is (0,0,0).

Definition at line 132 of file SoAxis.h.

axisOverScale

SoSFVec3f SoAxis::axisOverScale

Factor which makes the axis longer to be sure that arrows are not at position of last tick.

Default is 1.1.

Definition at line 191 of file SoAxis.h.

axisStepSizes

SoSFVec3f SoAxis::axisStepSizes

Determines distances between axis ticks. Default is (1,1,1).

Definition at line 129 of file SoAxis.h.

axisSubTickingOn

SoSFBool SoAxis::axisSubTickingOn

Enables/Disables drawing of subticks. Default is True.

Definition at line 89 of file SoAxis.h.

axisSubTickScales

SoSFVec3f SoAxis::axisSubTickScales

Tick lengthes multiplied with this scale factors result to size of subticks.

Default is (0.25, 0.25, 0.25), i.e. subticks have a quarter length of standard ticks.

Definition at line 199 of file SoAxis.h.

axisSubTickSteps

SoSFVec3f SoAxis::axisSubTickSteps

Subdivision of distance between ticks to determine smaller ticks between.

Default is (0.5, 0.5, 0.5), i.e. one sub tick is drawn between two normal ticks.

Definition at line 195 of file SoAxis.h.

axisText1AlignMode

SoSFEnum SoAxis::axisText1AlignMode

Type selector for text alignments, default is TEXT_ALIGN_LEFT.

Definition at line 120 of file SoAxis.h.

axisText2AlignMode

SoSFEnum SoAxis::axisText2AlignMode

Definition at line 121 of file SoAxis.h.

axisText3AlignMode

SoSFEnum SoAxis::axisText3AlignMode

Definition at line 122 of file SoAxis.h.

axisTicksMax

SoSFVec3f SoAxis::axisTicksMax

Position of the last axis tick. Default is (1,1,1).

Definition at line 147 of file SoAxis.h.

axisTicksMin

SoSFVec3f SoAxis::axisTicksMin

Position of the first axis tick. Default is (0,0,0).

Definition at line 144 of file SoAxis.h.

axisVolumeSize

SoSFVec3f SoAxis::axisVolumeSize

Field which is used as volume size input.

From it a complete configuration setting of the axis are possible via adjustSettings or autoAdjustSettings. Default is (1,1,1).

Definition at line 71 of file SoAxis.h.

axisWingLength

SoSFVec3f SoAxis::axisWingLength

Size the arrows at the end of each axis. Defaut is (0.5, 0.5, 0.5).

Definition at line 187 of file SoAxis.h.

boxColor

SoSFColor SoAxis::boxColor

Definition at line 179 of file SoAxis.h.

boxOn

SoSFBool SoAxis::boxOn

Enables/disables box drawing. Default is False.

Definition at line 184 of file SoAxis.h.

boxTransparency

SoSFFloat SoAxis::boxTransparency

Definition at line 180 of file SoAxis.h.

inputImage

SoSFMLImage SoAxis::inputImage

Pointer to input image field.

Definition at line 202 of file SoAxis.h.

multiAxisXY

SoSFBool SoAxis::multiAxisXY

Definition at line 93 of file SoAxis.h.

multiAxisXZ

SoSFBool SoAxis::multiAxisXZ

Definition at line 94 of file SoAxis.h.

multiAxisYX

SoSFBool SoAxis::multiAxisYX

Definition at line 95 of file SoAxis.h.

multiAxisYZ

SoSFBool SoAxis::multiAxisYZ

Definition at line 96 of file SoAxis.h.

multiAxisZX

SoSFBool SoAxis::multiAxisZX

Definition at line 97 of file SoAxis.h.

multiAxisZY

SoSFBool SoAxis::multiAxisZY

Definition at line 98 of file SoAxis.h.

numPostfix1Text

SoSFString SoAxis::numPostfix1Text

Definition at line 113 of file SoAxis.h.

numPostfix2Text

SoSFString SoAxis::numPostfix2Text

Definition at line 114 of file SoAxis.h.

numPostfix3Text

SoSFString SoAxis::numPostfix3Text

Definition at line 115 of file SoAxis.h.

numPrefix1Text

SoSFString SoAxis::numPrefix1Text

Text to be inserted/appended before/after axis numberings, defaults are "".

Definition at line 110 of file SoAxis.h.

numPrefix2Text

SoSFString SoAxis::numPrefix2Text

Definition at line 111 of file SoAxis.h.

numPrefix3Text

SoSFString SoAxis::numPrefix3Text

Definition at line 112 of file SoAxis.h.

---

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

• MeVisLab/Standard/Sources/Inventor/SoUtils/SoAxis.h