PoLinearAxis Class Reference
[Axis]

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

#include <MeshViz/graph/PoLinearAxis.h>

Inheritance diagram for PoLinearAxis:
PoCartesianAxis PoAxis PoBaseAxis PoGraphMaster PoBase SoBaseKit SoNode SoGetView SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

Classes

struct  LinAxisAttr
struct  MultFactor

Public Types

enum  GradFit {
  GRAD_FIT,
  GRAD_UNFIT
}
enum  MultFactorPosition {
  MULT_FACTOR_START,
  MULT_FACTOR_END,
  MULT_FACTOR_EXTR,
  MULT_FACTOR_GRAD
}

Public Member Functions

virtual SoType getTypeId () const
virtual const SoNodekitCataloggetNodekitCatalog () const
 PoLinearAxis ()
 PoLinearAxis (const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, float _step=0.0)
 PoLinearAxis (const SbVec3f &_start, float _end, PoCartesianAxis::Type _type, float _gradStart, float _gradEnd, float _step=0.0)
virtual void rebuild ()
void setFormat (PbNumericDisplayFormat *format)
const PbNumericDisplayFormatgetFormat () const
float getStep () const
void getMultFactor (MultFactorPosition &position, float &distAxis) const

Static Public Member Functions

static SoType getClassTypeId ()
static const SoNodekitCataloggetClassNodekitCatalog ()

Public Attributes

SoSFFloat step
SoSFEnum gradFit
SoSFEnum multFactorPosition
SoSFFloat multFactorDistAxis

Detailed Description

MeshViz Class to build a linear axis.

This class builds a linear axis. This axis will be generated between the point start and the point end. The graduations (tick marks, labels, etc) will be in the plane given by the field PoCartesianAxis::type.

By default, the text of the displayed graduations (the tick mark labels) are based on the actual coordinates of the axis (start and end). The text of the graduations is based on the specified range if the gradStart and gradEnd fields are not equal.

The 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 numerical display format is the inherited value from PoNumericDisplayFormat (default AUTO).

See PoAxis for discussion of axis attributes.

Axis Attributes
MainAxisAttributes.png

Many other kinds of axes can generated, for example:

Multiple axes can generated conveniently using PoGroup2Axis, etc.

FILE FORMAT/DEFAULT

SEE ALSO

PoGenAxis, PoLogAxis, PoLogAxis, PoTimeAxis, PoPolarLinAxis, PoPolarLogAxis

CATALOG PARTS

See related examples:

MedicalSimpleVolumeAxis


Member Enumeration Documentation

First graduation rounded or not.

Enumerator:
GRAD_FIT 

The first graduation is rounded.

GRAD_UNFIT 

The first graduation is not rounded.

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.


Constructor & Destructor Documentation

PoLinearAxis::PoLinearAxis (  )  [inline]

Default constructor.

PoLinearAxis::PoLinearAxis ( const SbVec3f _start,
float  _end,
PoCartesianAxis::Type  _type,
float  _step = 0.0 
) [inline]

Constructor.

PoLinearAxis::PoLinearAxis ( const SbVec3f _start,
float  _end,
PoCartesianAxis::Type  _type,
float  _gradStart,
float  _gradEnd,
float  _step = 0.0 
) [inline]

Constructor. Since Open Inventor 9.3


Member Function Documentation

static const SoNodekitCatalog* PoLinearAxis::getClassNodekitCatalog (  )  [static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoCartesianAxis.

static SoType PoLinearAxis::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from PoCartesianAxis.

const PbNumericDisplayFormat* PoLinearAxis::getFormat (  )  const

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

Returns null if none specified.

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

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

virtual const SoNodekitCatalog* PoLinearAxis::getNodekitCatalog (  )  const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoCartesianAxis.

float PoLinearAxis::getStep (  )  const

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

virtual SoType PoLinearAxis::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoCartesianAxis.

virtual void PoLinearAxis::rebuild (  )  [virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

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


Member Data Documentation

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

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.

Position of the multiplicative factor.

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:

Open Inventor Toolkit reference manual, generated on 28 Oct 2019
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/