Click or drag to resize
PoLinearAxis Class

Class to build a linear axis.

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.GraphPoAxis
                      OIV.MeshViz.GraphPoCartesianAxis
                        OIV.MeshViz.GraphPoLinearAxis

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2024.1.1.0 (2024.1.1)
Syntax
public class PoLinearAxis : PoCartesianAxis

The PoLinearAxis type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoBaseKit.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodCreatePathToPart(String, Boolean)
Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr).
(Inherited from SoBaseKit.)
Public methodCreatePathToPart(String, Boolean, SoPath)

Returns a path that begins at this nodekit and ends at partName.

(Inherited from SoBaseKit.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoBaseKit.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

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

Gets the arrow axis attributes computed by the last axis rebuilding.

(Inherited from PoAxis.)
Public methodGetBoundingBox
(Inherited from SoBaseKit.)
Public methodStatic memberGetClassNodekitCatalog

Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.

Public methodGetDomain

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

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetFormat

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

Public methodGetGrad

Gets the graduations axis attributes computed by the last axis rebuilding.

(Inherited from PoAxis.)
Public methodGetGrid

Gets the grid axis attributes computed by the last axis rebuilding.

(Inherited from PoAxis.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMargin

Gets the margin axis attributes computed by the last axis rebuilding.

(Inherited from PoAxis.)
Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetMiscTextAttr

Gets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes.

(Inherited from PoAxis.)
Public methodGetMultFactor

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

Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNodekitCatalog (Inherited from SoBaseKit.)
Public methodGetPart

Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

(Inherited from SoBaseKit.)
Public methodGetPartString

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.)
Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetReverseFlag

Gets the reverse flag axis attributes computed by the last axis rebuilding.

(Inherited from PoAxis.)
Public methodGetStep

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

Public methodGetStringName (Inherited from SoBase.)
Public methodGetTick

Gets the tick axis attributes computed by the last axis rebuilding.

(Inherited from PoAxis.)
Public methodGetTitle

Gets the title axis attributes computed by the last axis rebuilding.

(Inherited from PoAxis.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpdateMethod

Gets update method.

(Inherited from PoBase.)
Public methodGetViewportIsEnabled (Inherited from SoBaseKit.)
Public methodGetViewportOrigin (Inherited from SoBaseKit.)
Public methodGetViewportSize (Inherited from SoBaseKit.)
Public methodGLRender
(Inherited from SoBaseKit.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoBaseKit.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal.

(Inherited from SoBaseKit.)
Public methodIsBuilt

Indicates if the node kit has been built at least once.

(Inherited from PoBase.)
Public methodIsModified

Return true, if the kit has been modified, else otherwise.

(Inherited from PoBase.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoBaseKit.)
Public methodRebuild

Forces the node kit to be rebuilt immediately.

(Inherited from PoBase.)
Public methodSearch
(Inherited from SoBaseKit.)
Public methodSet(String)

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

(Inherited from SoBaseKit.)
Public methodSet(String, String)

This function allows field values of parts (nodes) to be set.

(Inherited from SoBaseKit.)
Public methodSetDomain

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

Sets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format for the graduations.

Public methodSetMiscTextAttr

Sets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes.

(Inherited from PoAxis.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetPart

Inserts the given node (not a copy) as the new part specified by partName.

(Inherited from SoBaseKit.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetUpdateMethod

Sets scene graph update method.

(Inherited from PoBase.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodTouchKit

Indicates the node kit is modified.

(Inherited from PoBase.)
Public methodWrite
(Inherited from SoBaseKit.)
Top
Properties
  NameDescription
Public propertyarrowHeight

Arrow height.

(Inherited from PoAxis.)
Public propertyarrowLength

Arrow length.

(Inherited from PoAxis.)
Public propertyarrowVisibility

Arrow visibility.

(Inherited from PoAxis.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertyend

Defines the end of the axis.

(Inherited from PoCartesianAxis.)
Public propertygradAddString

String to be concatenated.

(Inherited from PoAxis.)
Public propertygradAddStringVisibility

Specify the visibility of a string concatenated with the graduations.

(Inherited from PoAxis.)
Public propertygradDistAxis

Distance from the graduations to the axis.

(Inherited from PoAxis.)
Public propertygradEnd

Defines the value of the graduation (tick label) corresponding to the end coordinate of this axis.

(Inherited from PoCartesianAxis.)
Public propertygradFit

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

Public propertygradFontName

Graduations font name.

(Inherited from PoAxis.)
Public propertygradFontSize

Font size of the graduations.

(Inherited from PoAxis.)
Public propertygradPath

Graduations path.

(Inherited from PoAxis.)
Public propertygradPosition

Graduations position.

(Inherited from PoAxis.)
Public propertygradStart

Defines the value of the graduation (tick label) corresponding to the starting coordinate of this axis.

(Inherited from PoCartesianAxis.)
Public propertygradVisibility

Graduations visibility.

(Inherited from PoAxis.)
Public propertygridLengthGradOtherSide

Grid lines length other side graduation texts.

(Inherited from PoAxis.)
Public propertygridLengthGradSide

Grid lines length side graduation texts.

(Inherited from PoAxis.)
Public propertygridVisibility

Grid lines visibility.

(Inherited from PoAxis.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymarginEnd

Margin at the end of the axis.

(Inherited from PoAxis.)
Public propertymarginStart

Margin at the start of the axis.

(Inherited from PoAxis.)
Public propertymarginType

Relative or absolute margin.

(Inherited from PoAxis.)
Public propertymultFactorDistAxis

Distance from the multiplicative factor to the axis.

Public propertymultFactorPosition

Position of the multiplicative factor.

Public propertyreverseFlag

Allow to reverse the writing path of all axis texts.

(Inherited from PoAxis.)
Public propertystart

Defines the start of the axis.

(Inherited from PoCartesianAxis.)
Public propertystep

Defines the step for the axis.

Public propertytickFirstGrad

First graduation to display.

(Inherited from PoAxis.)
Public propertytickLastGrad

Last graduation to display (number starting with the ending one).

(Inherited from PoAxis.)
Public propertytickMainLength

Main graduations ticks length.

(Inherited from PoAxis.)
Public propertytickNumOrPeriod

Number of secondary graduations (tickSubDef = NUM_SUB_TICK), or period of texts of graduations (tickSubDef = PERIOD_MAIN_TICK).

(Inherited from PoAxis.)
Public propertytickPosition

Position of the tick marks.

(Inherited from PoAxis.)
Public propertytickSubDef

Secondary graduations tick definition.

(Inherited from PoAxis.)
Public propertytickSubLength

Secondary graduations ticks length.

(Inherited from PoAxis.)
Public propertytickVisibility

Tick marks visibility.

(Inherited from PoAxis.)
Public propertytitleDistAxis

Distance from the title to the axis.

(Inherited from PoAxis.)
Public propertytitleFontName

Title font name.

(Inherited from PoAxis.)
Public propertytitleFontSize

Font size of the title.

(Inherited from PoAxis.)
Public propertytitlePath

Path of the title.

(Inherited from PoAxis.)
Public propertytitlePosition

Position of the title.

(Inherited from PoAxis.)
Public propertytitleString

Title string.

(Inherited from PoAxis.)
Public propertytitleVisibility

Visibility of the title.

(Inherited from PoAxis.)
Public propertytype

Type of the axis (XY, XZ, YX, ...

(Inherited from PoCartesianAxis.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Events
  NameDescription
Public eventPostRebuild
(Inherited from PoBase.)
Public eventPreRebuild
(Inherited from PoBase.)
Top
Remarks

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 OIV.MeshViz.Graph.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 OIV.MeshViz.Nodes.PoNumericDisplayFormat (default AUTO).

See OIV.MeshViz.Graph.PoAxis for discussion of axis attributes.

Axis Attributes

Many other kinds of axes can generated, for example:

Multiple axes can generated conveniently using OIV.MeshViz.Graph.PoGroup2Axis, etc.

FILE FORMAT/DEFAULT

OIV.MeshViz.Graph.PoLinearAxis {
gradVisibility VISILITY_DEPEND
gradPosition GRAD_DEPEND
gradPath PATH_DEPEND
gradFontName ""
gradFontSize 0
gradDistAxis 0
gradAddStringVisibility false
gradAddString ""
marginType REL_MARGIN
marginStart 0
marginEnd 0
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
gradStart 0
gradEnd 0
type XY
step 0
gradFit GRAD_UNFIT
multFactorPosition MULT_FACTOR_END
multFactorDistAxis 0
}

<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading544">CATALOG PARTS</A></h4> <ul><b>PoLinearAxis</b> {</ul> <ul><ul><b>Separator</b> <tt>alternateRep</tt> (from PoBase) {<br /> </ul></ul> <ul><ul><ul><b>AppearanceKit</b> <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the domain transformation.</i></ul></ul></ul> <ul><ul><ul><b>MatrixTransform</b> <tt>transform</tt> (from PoAxis)</ul></ul></ul> <ul><ul><ul><i>Corresponds to the axis plane orientation matrix.</i></ul></ul></ul> <ul><ul><ul><b>Separator</b> <tt>bodySep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the body of the axis.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>bodyApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the body of the axis.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>body </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw the body of the axis.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>arrowSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw the arrow.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>arrowApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of the arrow.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>arrow </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoFaceSet shape to draw the arrow.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>subGradTickSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw sub-graduation tick.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>subGradTickApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of sub-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>subGradTick </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw sub-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>subGradGridSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw sub-graduation grid.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>subGradGridApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of sub-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>subGradGrid </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw sub-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>mainGradTickSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation tick.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradTickApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>mainGradTick </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw main-graduation tick.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>mainGradGridSep</tt> (from PoAxis){</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation grid.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradGridApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>mainGradGrid </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoLineSet shape to draw main-graduation grid.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>mainGradTextSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw main-graduation text.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>mainGradTextApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of main-graduation text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt. </i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>mainGradText </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shapes to draw main-graduation text.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>titleSep</tt> (from PoAxis) {</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw title text.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>titleApp </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of title text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>title </tt>(from PoAxis)</ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a SoAnnoText3 shape to draw title.</i></ul></ul></ul></ul> <ul><ul><ul>}<br /> <br /> <b>Separator</b> <tt>multFactorSep </tt>{</ul></ul></ul> <ul><ul><ul><i>Contains properties and shapes to draw multiplicative factor.</i></ul></ul></ul> <ul><ul><ul><ul><b>AppearanceKit</b> <tt>multFactorApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Specifies the appearance of multiplicative factor. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</i></ul></ul></ul></ul> <ul><ul><ul><ul><b>Group</b> <tt>multFactor</tt></ul></ul></ul></ul> <ul><ul><ul><ul><i>Contains a list of SoAnnoText3 shape to draw multiplicative factor.</i></ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul><br /> </ul></ul> </body> </html>

See Also