PoArrow3 Class

PoArrow3 Class

Class to build a 3D arrow.

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.GraphPoArrow3

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

Syntax

C++

Copy

public class PoArrow3 : PoGraphMaster

Public Class PoArrow3
	Inherits PoGraphMaster

public ref class PoArrow3 : public PoGraphMaster

type PoArrow3 =  
    class
        inherit PoGraphMaster
    end

The PoArrow3 type exposes the following members.

Constructors

	Name	Description
	PoArrow3	Default constructor.
	PoArrow3(SbVec3f)	Calls PoArrow3(_point, OIV.MeshViz.Graph.PoArrow3.PatternTypes( .PoArrow3.NO_PATTERN ), OIV.MeshViz.Graph.PoArrow3.PatternTypes( .PoArrow3.NO_PATTERN ), 0.05f, 0.03f).
	PoArrow3(SbVec3f, PoArrow3PatternTypes)	Calls PoArrow3(_point, startType, OIV.MeshViz.Graph.PoArrow3.PatternTypes( .PoArrow3.NO_PATTERN ), 0.05f, 0.03f).
	PoArrow3(SbVec3f, PoArrow3PatternTypes, PoArrow3PatternTypes)	Calls PoArrow3(_point, startType, endType, 0.05f, 0.03f).
	PoArrow3(SbVec3f, PoArrow3PatternTypes, PoArrow3PatternTypes, Single)	Calls PoArrow3(_point, startType, endType, _patternWidth, 0.03f).
	PoArrow3(SbVec3f, PoArrow3PatternTypes, PoArrow3PatternTypes, 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.)
	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.)
	endPatternType	Defines the end arrow pattern type.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	patternHeight	Define the height of the start and end arrow pattern.
	patternWidth	Define the width of the start and end arrow pattern.
	point	Point list of the arrow.
	startPatternType	Defines the start arrow pattern type.
	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 node draws a 3D arrow. The arrow is defined by a point list. The start pattern and the end pattern can be parameterized.

This node draws a single 3D arrow consisting of a polyline with optional arrowhead or rectangle at each end. Therefore the minimum number of points is 2. Additional points could be used to make, for example, a curved arrow.

FILE FORMAT/DEFAULT

OIV.MeshViz.Graph.PoArrow3 {
point 0 0 0
startPatternType NO_PATTERN
endPatternType NO_PATTERN
patternWidth 0.05
patternHeight 0.03
}

<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading481">CATALOG PARTS</A></h4> <ul>PoArrow3 {</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><ul></ul></ul></ul></ul> <ul><ul><ul>Separator <tt>bodySep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the body of the arrow.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>bodyApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the body of the arrow.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>body</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw the body of the arrow.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>startSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the start pattern of the arrow.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>startApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the start pattern of the arrow.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>start</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw the start pattern of the arrow.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>endSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the end pattern of the arrow.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>endApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the end pattern of the arrow.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>end</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw the end pattern of the arrow.</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

point	0 0 0
startPatternType	NO_PATTERN
endPatternType	NO_PATTERN
patternWidth	0.05
patternHeight	0.03