PoAutoCubeAxis Class Reference
[Axis]

Class to build a set of axes on a parallelepiped relating to the view. More...

#include <MeshViz/graph/PoAutoCubeAxis.h>

Inheritance diagram for PoAutoCubeAxis:

List of all members.

Public Types
enum	AxisType {   LINEAR,   LOGARITHMIC,   GENERALIZED }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoAutoCubeAxis ()
	PoAutoCubeAxis (const SbVec3f &_start, const SbVec3f &_end, AxisType xAxisType, AxisType yAxisType, AxisType zAxisType, const char *xTtle=NULL, const char *yTtle=NULL, const char *zTtle=NULL)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFVec3f	start
SoSFVec3f	end
SoSFVec3f	gradStart
SoSFVec3f	gradEnd
SoSFString	xTitle
SoSFString	yTitle
SoSFString	zTitle
SoSFBool	isGridLinesXVisible
SoSFBool	isGridLinesYVisible
SoSFBool	isGridLinesZVisible
SoSFBool	isBackgroundFacesVisible
SoSFBool	isIntersectingGradsVisible
SoSFMatrix	modellingMatrix
SoSFMatrix	viewingMatrix
SoSFMatrix	projectionMatrix

---

Detailed Description

Class to build a set of axes on a parallelepiped relating to the view.

This class builds a set of 3D axes displayed on some of the 12 edges of a parallelepiped. The choice of the edges depends on the view defined by the current camera (see SoCamera class). The graduations and the title of the axes are always legible whatever the view definition. The two points (start and end fields) define the diagonal of the parallelepiped and only the edges which are intersecting a visible face and an invisible face will be graduated. The visible and invisible faces depend on the view definition. The visible faces of the parallelepiped are the back faces.

                          1-----------2
          Y              /|  (2)     /|
          |            /  |        /  |
          |          /    | (5)  /    |   Vertices numerotation.
          |         6----------5      |
          ----- X   |     |    | (1)  |
         /          |(3)  0----|------3
        /           |    /     | (4) /
       /            |  /       |   /
      Z             |/ (0)     | /
                    7----------4

       Face 0 : 4 5 6 7 ==> edges : (4,5) (5,6) (6,7) (7,4)
       Face 1 : 2 3 4 5 ==> edges : (2,3) (3,4) (4,5) (5,2)
       Face 2 : 0 1 2 3 ==> edges : (0,1) (1,2) (2,3) (3,0)
       Face 3 : 0 1 6 7 ==> edges : (0,1) (1,6) (6,7) (7,0)
       Face 4 : 0 3 4 7 ==> edges : (0,3) (3,4) (4,7) (7,0)
       Face 5 : 1 2 5 6 ==> edges : (1,2) (2,5) (5,6) (6,1)
   

The graduations of these axes are defined by the fields gradStart and gradEnd. However if these fields are equal, the fields start and end are used to define the graduation values. Furthermore, the fields gradStart and gradEnd are always ignored for axis type GENERALIZED.

FILE FORMAT/DEFAULT

PoAutoCubeAxis {

start	0 0 0
end	1 1 1
gradStart	0 0 0
gradEnd	0 0 0
xTitle	""
yTitle	""
zTitle	""
isGridLinesXVisible	FALSE
isGridLinesYVisible	FALSE
isGridLinesZVisible	FALSE
isBackgroundFacesVisible	FALSE
isIntersectingGradsVisible	FALSE
modellingMatrix	1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1
viewingMatrix	1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1
projectionMatrix	1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

}

CATALOG PARTS

 
PoAutoCubeAxis {
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.
Separator backgroundFaceSep (from PoAutoCubeAxis) {
Contains properties and shapes to draw visible faces.
AppearanceKit backgroundFaceApp (from PoAutoCubeAxis)
Specifies the appearance of visible faces. By default lightModel.model=PHONG.
Group backgroundFace (from PoAutoCubeAxis)
Contains a SoFaceSet shape to draw the visible faces.
}

Separator mainGradGridSep (from PoAutoCubeAxis) {

Contains properties and shapes to draw grid lines of main graduations.
AppearanceKit mainGradGridApp (from PoAutoCubeAxis)
Specifies the appearance of grid lines of main graduations.
Group mainGradGrid (from PoAutoCubeAxis)
Contains a SoLineSet shape to draw the grid lines of main graduations.
}
Separator subGradGridSep (from PoAutoCubeAxis) {
Contains properties and shapes to draw grid lines of sub graduations.
AppearanceKit subGradGridApp (from PoAutoCubeAxis)
Specifies the appearance of grid lines of sub graduations.
Group subGradGrid (from PoAutoCubeAxis)
Contains a SoLineSet shape to draw the grid lines of sub graduations.
}

Switch xAxisSwitch03 (from PoAutoCubeAxis) {

PoLinearAxis/PoLogAxis/PoGenAxis xAxis03
Corresponds to the X-Axis with vertices 0-3
}
Switch xAxisSwitch12 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis xAxis12
Corresponds to the X-Axis with vertices 1-2
}
Switch xAxisSwitch65 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis xAxis65
Corresponds to the X-Axis with vertices 6-5
}
Switch xAxisSwitch74 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis xAxis74
Corresponds to the X-Axis with vertices 7-4
}
Switch yAxisSwitch01 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis yAxis01
Corresponds to the Y-Axis with vertices 0-1
}
Switch yAxisSwitch76 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis yAxis76
Corresponds to the Y-Axis with vertices 7-6
}
Switch yAxisSwitch45 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis yAxis45
Corresponds to the Y-Axis with vertices 4-5
}
Switch yAxisSwitch32 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis yAxis32
Corresponds to the Y-Axis with vertices 3-2
}
Switch zAxisSwitch07 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis zAxis07
Corresponds to the Z-Axis with vertices 0-7
}
Switch zAxisSwitch34 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis zAxis34
Corresponds to the Z-Axis with vertices 3-4
}
Switch zAxisSwitch25 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis zAxis25
Corresponds to the Z-Axis with vertices 2-5
}
Switch zAxisSwitch16 (from PoAutoCubeAxis) {
PoLinearAxis/PoLogAxis/PoGenAxis zAxis16
Corresponds to the Z-Axis with vertices 1-6
}
}
}

See related examples:

MedicalSimpleVolumeAxis

---

Member Enumeration Documentation

enum PoAutoCubeAxis::AxisType

Type of axes on the parallelepiped edges.

Enumerator:

LINEAR	Linear axis.
LOGARITHMIC	Logarithmic axis.
GENERALIZED	Generalized axes.

---

Constructor & Destructor Documentation

PoAutoCubeAxis::PoAutoCubeAxis

(

)

Default constructor.

PoAutoCubeAxis::PoAutoCubeAxis	(	const SbVec3f &	_start,
		const SbVec3f &	_end,
		AxisType	xAxisType,
		AxisType	yAxisType,
		AxisType	zAxisType,
		const char *	xTtle = NULL,
		const char *	yTtle = NULL,
		const char *	zTtle = NULL
	)

Constructor.

(By default the X, Y, and Z axes are linear).

---

Member Function Documentation

static const SoNodekitCatalog* PoAutoCubeAxis::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoBaseAxis.

static SoType PoAutoCubeAxis::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoBaseAxis.

virtual const SoNodekitCatalog* PoAutoCubeAxis::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoBaseAxis.

virtual SoType PoAutoCubeAxis::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoBaseAxis.

virtual void PoAutoCubeAxis::GLRender

(

SoGLRenderAction *

action

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

virtual void PoAutoCubeAxis::rebuild

(

)

[virtual]

Forces the node kit to be rebuilt immediately.

The rebuild consists in updating all catalog parts (which contains shapes forming the visualization) of the node kit according to field values and other property values (domain, data mapping,...). Be careful, do not use the method rebuild() if you use MeshViz property nodes (PoDomain, PoMeshProperty,...), because a representation (axis, legend, 2D and 3D mesh representation,..) depends on the current inherited state. If you need to do an extra work after a representation has been built, do it in a post-rebuild callback (cf PoBase::addPostRebuildCallback).

Reimplemented from PoBase.

---

Member Data Documentation

SoSFVec3f PoAutoCubeAxis::end

End point of the parallelepiped's diagonal.

(1,1,1) by default.

SoSFVec3f PoAutoCubeAxis::gradEnd

Defines the value of the graduation (tick label) corresponding to the end point of this group of axes.

See PoCartesianAxis::gradEnd for details.

Since Open Inventor 9.5.1

SoSFVec3f PoAutoCubeAxis::gradStart

Defines the value of the graduation (tick label) corresponding to the starting point of this group of axes.

See PoCartesianAxis::gradStart for details.

Since Open Inventor 9.5.1

SoSFBool PoAutoCubeAxis::isBackgroundFacesVisible

Sets the visibility of visible faces.

FALSE by default.

SoSFBool PoAutoCubeAxis::isGridLinesXVisible

Sets the visibility of the grid lines of the X axes displayed on the visible faces.

(The attributes of grid lines of PoAxis cannot be used because the graduations of thes axes are not necessarily in the same plane than the visible faces). FALSE by default.

SoSFBool PoAutoCubeAxis::isGridLinesYVisible

Sets the visibility of the grid lines of the Y axes displayed on the visible faces.

(The attributes of grid lines of PoAxis cannot be used because the graduations of thes axes are not necessarily in the same plane than the visible faces). FALSE by default.

SoSFBool PoAutoCubeAxis::isGridLinesZVisible

Sets the visibility of the grid lines of the Z axes displayed on the visible faces.

(The attributes of grid lines of PoAxis cannot be used because the graduations of thes axes are not necessarily in the same plane than the visible faces). FALSE by default.

SoSFBool PoAutoCubeAxis::isIntersectingGradsVisible

Given A1 and A2 2 consecutive axes with the first (the last) graduation of A1 intersects the first or the last graduation of A2.

This flag allows the application to suppress or not the first (the last) graduation of A1. The attribute tickFirstGrad (tickLastGrad) of PoAxis is used to suppress the first (the last) graduation. FALSE by default.

SoSFMatrix PoAutoCubeAxis::modellingMatrix

This modelling matrix is used to determine the visibility of each face (and thus the axes to draw).

Each time an SoGLRenderAction, an SoCallbackAction, an SoRayPickAction or an SoVectorizeAction traverse this node, this matrix is set to the current modelling matrix and the axes are rebuilt.

SoSFMatrix PoAutoCubeAxis::projectionMatrix

This modelling matrix is used to determine the visibility of each face (and thus the axes to draw).

Each time an SoGLRenderAction, an SoCallbackAction, an SoRayPickAction or an SoVectorizeAction traverse this node, this matrix is set to the current projection matrix and the axes are rebuilt. projectionMatrix depends on the current camera.

SoSFVec3f PoAutoCubeAxis::start

Start point of the parallelepiped's diagonal.

(0,0,0) by default.

SoSFMatrix PoAutoCubeAxis::viewingMatrix

This viewing matrix is used to determine the visibility of each face (and thus the axes to draw).

Each time an SoGLRenderAction, an SoCallbackAction, an SoRayPickAction or an SoVectorizeAction traverse this node, this matrix is set to the current viewing matrix and the axes are rebuilt. viewingMatrix depends on the current camera.

SoSFString PoAutoCubeAxis::xTitle

Title of the X axes.

Empty by default.

SoSFString PoAutoCubeAxis::yTitle

Title of the Y axes.

Empty by default.

SoSFString PoAutoCubeAxis::zTitle

Title of the Z axes.

Empty by default.

---

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