PoPolarLinAxis Class

Class to build a polar 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.GraphPoPolarAxis
                        OIV.MeshViz.GraphPoPolarLinAxis

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2024.1.1.0 (2024.1.1)

Syntax

C++

Copy

public class PoPolarLinAxis : PoPolarAxis

Public Class PoPolarLinAxis
	Inherits PoPolarAxis

public ref class PoPolarLinAxis : public PoPolarAxis

type PoPolarLinAxis =  
    class
        inherit PoPolarAxis
    end

The PoPolarLinAxis type exposes the following members.

Constructors

	Name	Description
	PoPolarLinAxis	Default constructor.
	PoPolarLinAxis(Single, Single, Single, Single)	Calls PoPolarLinAxis(offset, startRadius, endRadius, theta, 0.0).
	PoPolarLinAxis(Single, Single, Single, Single, Single)	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.)
	GetArrow	Gets the arrow axis attributes computed by the last axis rebuilding. (Inherited from PoAxis.)
	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.)
	GetFormat	Gets a reference to a 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. (Inherited from PoAxis.)
	GetGrid	Gets the grid axis attributes computed by the last axis rebuilding. (Inherited from PoAxis.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMargin	Gets the margin axis attributes computed by the last axis rebuilding. (Inherited from PoAxis.)
	GetMatrix	(Inherited from SoBaseKit.)
	GetMiscTextAttr	Gets a reference to OIV.MeshViz.Graph.PbMiscTextAttr object for miscellaneous text attributes. (Inherited from PoAxis.)
	GetMultFactor	Returns the current multiplicative factor attributes (those computed can be different from the associated fields). (Inherited from PoPolarAxis.)
	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. (Inherited from PoAxis.)
	GetStep	Returns the step (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. (Inherited from PoAxis.)
	GetTitle	Gets the title axis attributes computed by the last axis rebuilding. (Inherited from PoAxis.)
	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.)
	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. (Inherited from PoAxis.)
	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. (Inherited from PoAxis.)
	arrowLength	Arrow length. (Inherited from PoAxis.)
	arrowVisibility	Arrow visibility. (Inherited from PoAxis.)
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	endRadius	Radius at the end of the axis. (Inherited from PoPolarAxis.)
	gradAddString	String to be concatenated. (Inherited from PoAxis.)
	gradAddStringVisibility	Specify the visibility of a string concatenated with the graduations. (Inherited from PoAxis.)
	gradDistAxis	Distance from the graduations to the axis. (Inherited from PoAxis.)
	gradFit	This flag indicates if the first graduation is rounded or not.
	gradFontName	Graduations font name. (Inherited from PoAxis.)
	gradFontSize	Font size of the graduations. (Inherited from PoAxis.)
	gradPath	Graduations path. (Inherited from PoAxis.)
	gradPosition	Graduations position. (Inherited from PoAxis.)
	gradVisibility	Graduations visibility. (Inherited from PoAxis.)
	gridLengthGradOtherSide	Grid lines length other side graduation texts. (Inherited from PoAxis.)
	gridLengthGradSide	Grid lines length side graduation texts. (Inherited from PoAxis.)
	gridVisibility	Grid lines visibility. (Inherited from PoAxis.)
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	marginEnd	Margin at the end of the axis. (Inherited from PoAxis.)
	marginStart	Margin at the start of the axis. (Inherited from PoAxis.)
	marginType	Relative or absolute margin. (Inherited from PoAxis.)
	multFactorDistAxis	Distance from the mutiplicative factor to the axis. (Inherited from PoPolarAxis.)
	multFactorPosition	Position of the multiplicative factor. (Inherited from PoPolarAxis.)
	offset	Offset for the axis. (Inherited from PoPolarAxis.)
	reverseFlag	Allow to reverse the writing path of all axis texts. (Inherited from PoAxis.)
	startRadius	Radius at the start of the axis. (Inherited from PoPolarAxis.)
	step	Defines the step for the axis.
	theta	Rotation angle of the axis in radians. (Inherited from PoPolarAxis.)
	tickFirstGrad	First graduation to display. (Inherited from PoAxis.)
	tickLastGrad	Last graduation to display (number starting with the ending one). (Inherited from PoAxis.)
	tickMainLength	Main graduations ticks length. (Inherited from PoAxis.)
	tickNumOrPeriod	Number of secondary graduations (tickSubDef = NUM_SUB_TICK), or period of texts of graduations (tickSubDef = PERIOD_MAIN_TICK). (Inherited from PoAxis.)
	tickPosition	Position of the tick marks. (Inherited from PoAxis.)
	tickSubDef	Secondary graduations tick definition. (Inherited from PoAxis.)
	tickSubLength	Secondary graduations ticks length. (Inherited from PoAxis.)
	tickVisibility	Tick marks visibility. (Inherited from PoAxis.)
	titleDistAxis	Distance from the title to the axis. (Inherited from PoAxis.)
	titleFontName	Title font name. (Inherited from PoAxis.)
	titleFontSize	Font size of the title. (Inherited from PoAxis.)
	titlePath	Path of the title. (Inherited from PoAxis.)
	titlePosition	Position of the title. (Inherited from PoAxis.)
	titleString	Title string. (Inherited from PoAxis.)
	titleVisibility	Visibility of the title. (Inherited from PoAxis.)
	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 builds a polar linear axis in the plane XY. This axis will be generated from the point in polar coordinate (startRadius + offset, theta) to the point (endRadius + offset, theta), however the graduations start at startRadius and finish at endRadius.

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 current numerical display format is specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoNumericDisplayFormat).

FILE FORMAT/DEFAULT

OIV.MeshViz.Graph.PoPolarLinAxis {
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
offset 0
startRadius 0
endRadius 1
theta 0
multFactorPosition MULT_FACTOR_END
multFactorDistAxis 0
step 0
gradFit GRAD_UNFIT
}

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

Reference

OIV.MeshViz.Graph Namespace

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
offset	0
startRadius	0
endRadius	1
theta	0
multFactorPosition	MULT_FACTOR_END
multFactorDistAxis	0
step	0
gradFit	GRAD_UNFIT