PoLinearAxis Class |
Class to build a linear axis.
Namespace: OIV.MeshViz.Graph
The PoLinearAxis type exposes the following members.
Name | Description | |
---|---|---|
PoLinearAxis | Default constructor. | |
PoLinearAxis(SbVec3f, Single, PoCartesianAxisTypes) | Calls PoLinearAxis(_start, _end, _type, 0.0). | |
PoLinearAxis(SbVec3f, Single, PoCartesianAxisTypes, Single) | Constructor. | |
PoLinearAxis(SbVec3f, Single, PoCartesianAxisTypes, Single, Single) | Calls PoLinearAxis(_start, _end, _type, _gradStart, _gradEnd, 0.0). | |
PoLinearAxis(SbVec3f, Single, PoCartesianAxisTypes, Single, Single, Single) | Constructor. |
Name | Description | |
---|---|---|
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoBaseKit.) | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) | |
CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. | |
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. | |
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). | |
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. | |
Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetArrow | Gets the arrow axis attributes computed by the last axis rebuilding. | |
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. | |
GetEventIn | Returns a the eventIn with the given name. | |
GetEventOut | Returns the eventOut with the given name. | |
GetField | Returns a the field of this object whose name is fieldName. | |
GetFieldName | Returns the name of the given field in the fieldName argument. | |
GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
GetFormat | Gets a reference to the OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format for the graduations. | |
GetGrad | Gets the graduations axis attributes computed by the last axis rebuilding. | |
GetGrid | Gets the grid axis attributes computed by the last axis rebuilding. | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetMargin | Gets the margin axis attributes computed by the last axis rebuilding. | |
GetMatrix | (Inherited from SoBaseKit.) | |
GetMiscTextAttr | Gets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes. | |
GetMultFactor | Returns the current multiplicative factor attributes (those computed can be different from the associated field). | |
GetName | Returns the name of an instance. | |
GetNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. | |
GetPart | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
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. | |
GetPrimitiveCount | (Inherited from SoBaseKit.) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetReverseFlag | Gets the reverse flag axis attributes computed by the last axis rebuilding. | |
GetStep | Returns the current step attribute (the step computed can be different from the associated field). | |
GetStringName | (Inherited from SoBase.) | |
GetTick | Gets the tick axis attributes computed by the last axis rebuilding. | |
GetTitle | Gets the title axis attributes computed by the last axis rebuilding. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUpdateMethod | Gets update method. | |
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. | |
IsBoundingBoxIgnoring | Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. | |
IsBuilt | Indicates if the node kit has been built at least once. | |
IsModified | Return true, if the kit has been modified, else otherwise. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Inherited from SoNode.) | |
RayPick | (Inherited from SoBaseKit.) | |
Rebuild | Forces the node kit to be rebuilt immediately. | |
Search | (Inherited from SoBaseKit.) | |
Set(String) | This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
Set(String, String) | This function allows field values of parts (nodes) to be set. | |
SetDomain | Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. | |
SetFormat | Sets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format for the graduations. | |
SetMiscTextAttr | Sets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetPart | Inserts the given node (not a copy) as the new part specified by partName. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
SetUpdateMethod | Sets scene graph update method. | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
TouchKit | Indicates the node kit is modified. | |
Write | (Inherited from SoBaseKit.) |
Name | Description | |
---|---|---|
arrowHeight | Arrow height. | |
arrowLength | Arrow length. | |
arrowVisibility | Arrow visibility. | |
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
end | Defines the end of the axis. | |
gradAddString | String to be concatenated. | |
gradAddStringVisibility | Specify the visibility of a string concatenated with the graduations. | |
gradDistAxis | Distance from the graduations to the axis. | |
gradEnd | Defines the value of the graduation (tick label) corresponding to the end coordinate of this axis. | |
gradFit | This flag indicates if the first graduation is rounded or not. | |
gradFontName | Graduations font name. | |
gradFontSize | Font size of the graduations. | |
gradPath | Graduations path. | |
gradPosition | Graduations position. | |
gradStart | Defines the value of the graduation (tick label) corresponding to the starting coordinate of this axis. | |
gradVisibility | Graduations visibility. | |
gridLengthGradOtherSide | Grid lines length other side graduation texts. | |
gridLengthGradSide | Grid lines length side graduation texts. | |
gridVisibility | Grid lines visibility. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
marginEnd | Margin at the end of the axis. | |
marginStart | Margin at the start of the axis. | |
marginType | Relative or absolute margin. | |
multFactorDistAxis | Distance from the multiplicative factor to the axis. | |
multFactorPosition | Position of the multiplicative factor. | |
reverseFlag | Allow to reverse the writing path of all axis texts. | |
start | Defines the start of the axis. | |
step | Defines the step for the axis. | |
tickFirstGrad | First graduation to display. | |
tickLastGrad | Last graduation to display (number starting with the ending one). | |
tickMainLength | Main graduations ticks length. | |
tickNumOrPeriod | Number of secondary graduations (tickSubDef = NUM_SUB_TICK), or period of texts of graduations (tickSubDef = PERIOD_MAIN_TICK). | |
tickPosition | Position of the tick marks. | |
tickSubDef | Secondary graduations tick definition. | |
tickSubLength | Secondary graduations ticks length. | |
tickVisibility | Tick marks visibility. | |
titleDistAxis | Distance from the title to the axis. | |
titleFontName | Title font name. | |
titleFontSize | Font size of the title. | |
titlePath | Path of the title. | |
titlePosition | Position of the title. | |
titleString | Title string. | |
titleVisibility | Visibility of the title. | |
type | Type of the axis (XY, XZ, YX, ... | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Name | Description | |
---|---|---|
PostRebuild | (Inherited from PoBase.) | |
PreRebuild | (Inherited from PoBase.) |
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 |
Log axis (OIV.MeshViz.Graph.PoLogAxis)
Time axis (OIV.MeshViz.Graph.PoTimeAxis)
General non-numeric axis (OIV.MeshViz.Graph.PoGenAxis)
Polar axis (OIV.MeshViz.Graph.PoPolarLinAxis, OIV.MeshViz.Graph.PoPolarLogAxis)
Multiple axes can generated conveniently using OIV.MeshViz.Graph.PoGroup2Axis, etc.
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 |