PoAxis Class

PoAxis Class

Abstract class for axis representations.

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.GraphPoAngularAxis
                      OIV.MeshViz.GraphPoCartesianAxis
                      OIV.MeshViz.GraphPoPolarAxis
                      OIV.MeshViz.GraphPoTimeAxis

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2024.2.2.0 (10.16.2.0)

Syntax

C++

Copy

public class PoAxis : PoBaseAxis

Public Class PoAxis
	Inherits PoBaseAxis

public ref class PoAxis : public PoBaseAxis

type PoAxis =  
    class
        inherit PoBaseAxis
    end

The PoAxis type exposes the following members.

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.)
	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. (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.)
	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.
	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.)
	GetReverseFlag	Gets the reverse flag axis attributes computed by the last axis rebuilding.
	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. (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.)
	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. (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
	arrowHeight	Arrow height.
	arrowLength	Arrow length.
	arrowVisibility	Arrow visibility.
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	gradAddString	String to be concatenated.
	gradAddStringVisibility	Specify the visibility of a string concatenated with the graduations.
	gradDistAxis	Distance from the graduations to the axis.
	gradFontName	Graduations font name.
	gradFontSize	Font size of the graduations.
	gradPath	Graduations path.
	gradPosition	Graduations position.
	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.
	reverseFlag	Allow to reverse the writing path of all axis texts.
	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.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Events

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

Top

Remarks

This class groups all common methods and all common fields of all axes. Some enumerations are named DEPEND, in such a case, the choice of these values is done when building the axis.

All axis texts depend on the current miscellaneous text attributes which define the font name, line length and so on. If the method setMiscTextAttr(textAttr) is called, the current miscellaneous text attributes are defined by "textAttr". Otherwise the current miscellaneous text attributes are specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoMiscTextAttr).

Reference

OIV.MeshViz.Graph Namespace