PoAutoCubeAxis Class

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

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodekitsSoBaseKit
              OIV.MeshViz.GraphPoBase
                OIV.MeshViz.GraphPoGraphMaster
                  OIV.MeshViz.GraphPoBaseAxis
                    OIV.MeshViz.GraphPoAutoCubeAxis

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class PoAutoCubeAxis : PoBaseAxis

Public Class PoAutoCubeAxis
	Inherits PoBaseAxis

public ref class PoAutoCubeAxis : public PoBaseAxis

type PoAutoCubeAxis =  
    class
        inherit PoBaseAxis
    end

The PoAutoCubeAxis type exposes the following members.

Constructors

	Name	Description
	PoAutoCubeAxis	Default constructor.
	PoAutoCubeAxis(SbVec3f, SbVec3f, PoAutoCubeAxisAxisTypes, PoAutoCubeAxisAxisTypes, PoAutoCubeAxisAxisTypes)	Calls PoAutoCubeAxis(_start, _end, xAxisType, yAxisType, zAxisType, (System.String ^)nullptr, (System.String ^)nullptr, (System.String ^)nullptr).
	PoAutoCubeAxis(SbVec3f, SbVec3f, PoAutoCubeAxisAxisTypes, PoAutoCubeAxisAxisTypes, PoAutoCubeAxisAxisTypes, String)	Calls PoAutoCubeAxis(_start, _end, xAxisType, yAxisType, zAxisType, xTtle, (System.String ^)nullptr, (System.String ^)nullptr).
	PoAutoCubeAxis(SbVec3f, SbVec3f, PoAutoCubeAxisAxisTypes, PoAutoCubeAxisAxisTypes, PoAutoCubeAxisAxisTypes, String, String)	Calls PoAutoCubeAxis(_start, _end, xAxisType, yAxisType, zAxisType, xTtle, yTtle, (System.String ^)nullptr).
	PoAutoCubeAxis(SbVec3f, SbVec3f, PoAutoCubeAxisAxisTypes, PoAutoCubeAxisAxisTypes, PoAutoCubeAxisAxisTypes, String, String, String)	Constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Inherited from SoBaseKit.)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	CreatePathToPart(String, Boolean)	Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.)
	CreatePathToPart(String, Boolean, SoPath)	Returns a path that begins at this nodekit and ends at partName. (Inherited from SoBaseKit.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Inherited from SoBaseKit.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	(Inherited from SoBaseKit.)
	GetClassNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.
	GetDomain	Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. (Inherited from PoBase.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoBaseKit.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. (Inherited from SoBaseKit.)
	GetPart	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. (Inherited from SoBaseKit.)
	GetPartString	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. (Inherited from SoBaseKit.)
	GetPrimitiveCount	(Inherited from SoBaseKit.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUpdateMethod	Gets update method. (Inherited from PoBase.)
	GetViewportIsEnabled	(Inherited from SoBaseKit.)
	GetViewportOrigin	(Inherited from SoBaseKit.)
	GetViewportSize	(Inherited from SoBaseKit.)
	GLRender	(Inherited from SoBaseKit.)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoBaseKit.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. (Inherited from SoBaseKit.)
	IsBuilt	Indicates if the node kit has been built at least once. (Inherited from PoBase.)
	IsModified	Return true, if the kit has been modified, else otherwise. (Inherited from PoBase.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	(Inherited from SoBaseKit.)
	Rebuild	Forces the node kit to be rebuilt immediately. (Inherited from PoBase.)
	Search	(Inherited from SoBaseKit.)
	Set(String)	This function allows field values of parts (nodes) to be set in several different parts simultaneously. (Inherited from SoBaseKit.)
	Set(String, String)	This function allows field values of parts (nodes) to be set. (Inherited from SoBaseKit.)
	SetDomain	Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. (Inherited from PoBase.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetPart	Inserts the given node (not a copy) as the new part specified by partName. (Inherited from SoBaseKit.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	SetUpdateMethod	Sets scene graph update method. (Inherited from PoBase.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	TouchKit	Indicates the node kit is modified. (Inherited from PoBase.)
	Write	(Inherited from SoBaseKit.)

Top

Properties

	Name	Description
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	end	End point of the parallelepiped's diagonal.
	gradEnd	Defines the value of the graduation (tick label) corresponding to the end point of this group of axes.
	gradStart	Defines the value of the graduation (tick label) corresponding to the starting point of this group of axes.
	isBackgroundFacesVisible	Sets the visibility of visible faces.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	isGridLinesXVisible	Sets the visibility of the grid lines of the X axes displayed on the visible faces.
	isGridLinesYVisible	Sets the visibility of the grid lines of the Y axes displayed on the visible faces.
	isGridLinesZVisible	Sets the visibility of the grid lines of the Z axes displayed on the visible faces.
	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.
	modellingMatrix	This modelling matrix is used to determine the visibility of each face (and thus the axes to draw).
	projectionMatrix	This modelling matrix is used to determine the visibility of each face (and thus the axes to draw).
	start	Start point of the parallelepiped's diagonal.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	viewingMatrix	This viewing matrix is used to determine the visibility of each face (and thus the axes to draw).
	xTitle	Title of the X axes.
	yTitle	Title of the Y axes.
	zTitle	Title of the Z axes.

Top

Events

	Name	Description
	PostRebuild	(Inherited from PoBase.)
	PreRebuild	(Inherited from PoBase.)

Top

Remarks

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 OIV.Inventor.Nodes.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 OIV.MeshViz.Graph.PoAutoCubeAxis.gradStart and OIV.MeshViz.Graph.PoAutoCubeAxis.gradEnd. However if these fields are equal, the fields OIV.MeshViz.Graph.PoAutoCubeAxis.start and OIV.MeshViz.Graph.PoAutoCubeAxis.end are used to define the graduation values. Furthermore, the fields OIV.MeshViz.Graph.PoAutoCubeAxis.gradStart and OIV.MeshViz.Graph.PoAutoCubeAxis.gradEnd are always ignored for axis type OIV.MeshViz.Graph.PoAutoCubeAxis.AxisTypes.GENERALIZED.

FILE FORMAT/DEFAULT

OIV.MeshViz.Graph.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
}

<HTML> <HEAD> </HEAD> <body> <H4> <A NAME="Heading652"></A>CATALOG PARTS</H4> <CENTER></CENTER> <CENTER></CENTER> <UL>PoAutoCubeAxis {</UL> <UL> <UL>Separator <TT>alternateRep</TT> (from PoBase) {</UL> </UL> <UL> <UL> <UL>AppearanceKit <TT>appearance</TT> (from PoBase)</UL> </UL> </UL> <UL> <UL> <UL>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</UL> </UL> </UL> <UL> <UL> <UL>MatrixTransform <TT>domainTransform</TT> (from PoBase)</UL> </UL> </UL> <UL> <UL> <UL>Corresponds to the domain transformation.</UL> </UL> </UL> <UL> <UL> <UL>Separator <TT>backgroundFaceSep</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL>Contains properties and shapes to draw visible faces.</UL> </UL> </UL> <UL> <UL> <UL> <UL>AppearanceKit <TT>backgroundFaceApp </TT>(from PoAutoCubeAxis)</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Specifies the appearance of visible faces. By default lightModel.model=PHONG.</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Group <TT>backgroundFace </TT>(from PoAutoCubeAxis)</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Contains a SoFaceSet shape to draw the visible faces.</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Separator <TT>mainGradGridSep</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL>Contains properties and shapes to draw grid lines of main graduations.</UL> </UL> </UL> <UL> <UL> <UL> <UL>AppearanceKit <TT>mainGradGridApp </TT>(from PoAutoCubeAxis)</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Specifies the appearance of grid lines of main graduations.</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Group <TT>mainGradGrid </TT>(from PoAutoCubeAxis)</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Contains a SoLineSet shape to draw the grid lines of main graduations.</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Separator <TT>subGradGridSep</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL>Contains properties and shapes to draw grid lines of sub graduations.</UL> </UL> </UL> <UL> <UL> <UL> <UL>AppearanceKit <TT>subGradGridApp </TT>(from PoAutoCubeAxis)</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Specifies the appearance of grid lines of sub graduations.</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Group <TT>subGradGrid </TT>(from PoAutoCubeAxis)</UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Contains a SoLineSet shape to draw the grid lines of sub graduations.</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>xAxisSwitch03</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>xAxis03</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the X-Axis with vertices 0-3</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>xAxisSwitch12</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>xAxis12</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the X-Axis with vertices 1-2</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>xAxisSwitch65</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>xAxis65</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the X-Axis with vertices 6-5</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>xAxisSwitch74</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>xAxis74</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the X-Axis with vertices 7-4</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>yAxisSwitch01</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>yAxis01</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the Y-Axis with vertices 0-1</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>yAxisSwitch76</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>yAxis76</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the Y-Axis with vertices 7-6</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>yAxisSwitch45</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>yAxis45</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the Y-Axis with vertices 4-5</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>yAxisSwitch32</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>yAxis32</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the Y-Axis with vertices 3-2</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>zAxisSwitch07</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>zAxis07</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the Z-Axis with vertices 0-7</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>zAxisSwitch34</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>zAxis34</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the Z-Axis with vertices 3-4</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>zAxisSwitch25</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>zAxis25</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the Z-Axis with vertices 2-5</UL> </UL> </UL> </UL> <UL> <UL> <UL>} Switch <TT>zAxisSwitch16</TT> (from PoAutoCubeAxis) {</UL> </UL> </UL> <UL> <UL> <UL> <UL>PoLinearAxis/PoLogAxis/PoGenAxis <TT>zAxis16</TT></UL> </UL> </UL> </UL> <UL> <UL> <UL> <UL>Corresponds to the Z-Axis with vertices 1-6</UL> </UL> </UL> </UL> <UL> <UL> <UL>}</UL> </UL> </UL> <UL> <UL>}</UL> </UL> <UL>}</UL> </body> </HTML>

Reference

OIV.MeshViz.Graph Namespace

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