Arrow3D Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

The class assembles a simple 3D arrow out of several 3D shapes.

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.DrawingArrow3D

Namespace: ILNumerics.Drawing
Assembly: ILNumerics.Drawing (in ILNumerics.Drawing.dll) Version: ILNumerics Ultimate VS 4

Syntax

Copy

[SerializableAttribute]
public class Arrow3D : Group

<SerializableAttribute>
Public Class Arrow3D
	Inherits Group

Dim instance As Arrow3D

The Arrow3D type exposes the following members.

Constructors

	Name	Description
	Arrow3D	Initializes a new instance of the Arrow3D class

Top

Properties

	Name	Description
	Alpha	Alpha value, range [0...1], if set, this value modifies the alpha values for ALL nodes of this subtree. Use for blend effects only! [ILNumerics Visualization Engine] (Inherited from Group.)
	Animations	(Inherited from Group.)
	Body	Gets access to the triangles shape constructing the cylinder hull of the arrow body. [ILNumerics Visualization Engine]
	BodyGroup	Gets access to the group node containing the shapes for the body for individual configuration. [ILNumerics Visualization Engine]
	Bottom	Gets access to the triangles shape constructing the bottom of the arrow body. [ILNumerics Visualization Engine]
	BottomBorder	Gets access to the lines shape constructing the border around the bottom of the arrow body. [ILNumerics Visualization Engine]
	Children	Collection of child for this group [ILNumerics Visualization Engine] (Inherited from Group.)
	Clipping	Gets all 6 available clipping planes for the group or sets it. Null: derive clipping from parent node (default) [ILNumerics Visualization Engine] (Inherited from Group.)
	ColorOverride	If set, this color will override all individual colors in this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	ConeBorder	Gets access to the lines shape constructing the cone border of the arrow head. [ILNumerics Visualization Engine]
	ConeBottom	Gets access to the triangles shape constructing the bottom of the cone for the arrow head. [ILNumerics Visualization Engine]
	ConeHull	Gets access to the triangles shape constructing the cone hull of the arrow head. [ILNumerics Visualization Engine]
	HeadGroup	Gets access to the group node containing the shapes for the head for individual configuration. [ILNumerics Visualization Engine]
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	IsSynchedNode	(Inherited from Node.)
	Markable	Determines, if this node can be marked by the user [ILNumerics Visualization Engine] (Inherited from Node.)
	Marked	Marked state for the node [ILNumerics Visualization Engine] (Inherited from Node.)
	Parent	Get the parent of this node or null, if this node is a root node [ILNumerics Visualization Engine] (Inherited from Node.)
	PickingID	If set to a valid shape ID, that shape will be marked in picking operations insted of this shape. [ILNumerics Visualization Engine] (Inherited from Node.)
	SynchedVersion	The version of the sync source from the last synchronization. [ILNumerics Visualization Engine] (Inherited from Node.)
	Tag	Object tag used to identify the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	Target	If set, determines the target for rendering: world (3D) or screen (2D) on top. Default: not set (derive from parent) [ILNumerics Visualization Engine] (Inherited from Group.)
	TimeoutAware	Sets if this group and all children are sensible for timeouts during rendering or gets that flag. Default: null -> derive from parent [ILNumerics Visualization Engine] (Inherited from Group.)
	Transform	[4x4] matrix with the affine transforms which this node applies to all children [ILNumerics Visualization Engine] (Inherited from Group.)
	Version	Modification version of this node, gets incremented at every change [ILNumerics Visualization Engine] (Inherited from Node.)
	Visible	Determines, if this node is visible or sets the visible state [ILNumerics Visualization Engine] (Inherited from Node.)

Top

Methods

	Name	Description
	Add(Node)	Add a node to the end of this groups child collection [ILNumerics Visualization Engine] (Inherited from Group.)
	AddT(T, Object, Boolean)	Add a node to the end of this groups child collection [ILNumerics Visualization Engine] (Inherited from Group.)
	BeginVisit	pushes the transform, alpha and color overrides of this node to the render parameter stack [ILNumerics Visualization Engine] (Inherited from Group.)
	Configure	Configure the subtree after changes to any buffer [ILNumerics Visualization Engine] (Inherited from Group.)
	Copy	Create a shallow copy of this arrow, sharing buffers. [ILNumerics Visualization Engine] (Overrides GroupCopy.)
	CreateSynchedCopy	(Overrides GroupCreateSynchedCopy(Node).)
	Detach	Detach all shapes from this subtree for individual configurations [ILNumerics Visualization Engine] (Inherited from Group.)
	Dispose	Dispose the complete subtree (this is rarely needed) [ILNumerics Visualization Engine] (Inherited from Group.)
	EndVisit	pops the render parameter from render parameter stack [ILNumerics Visualization Engine] (Inherited from Group.)
	Find(Object, NullablePrimitives)	Searches the subtree for nodes with matching tag and (optional) primitive type [ILNumerics Visualization Engine] (Inherited from Group.)
	FindT(Object, PredicateT)	Searches the subtree for all nodes with matching criteria [ILNumerics Visualization Engine] (Inherited from Group.)
	FindByIdT	Finds a typed node in this subtree, filter by ID [ILNumerics Visualization Engine] (Inherited from Group.)
	FirstT	Gets first node with matching criteria from subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	FirstUpT	Finds a group node on the path up to root [ILNumerics Visualization Engine] (Inherited from Group.)
	GetEnumerator	(Inherited from Group.)
	GetLimits	Compute the 3D limits (extent) of this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	getLimitsInternal	(Inherited from Group.)
	InsertT	Insert a node into the child collection at predefined index [ILNumerics Visualization Engine] (Inherited from Group.)
	OnDisposing	(Inherited from Node.)
	OnMouseClick	(Inherited from Node.)
	OnMouseDoubleClick	(Inherited from Node.)
	OnMouseDown	(Inherited from Node.)
	OnMouseEnter	(Inherited from Node.)
	OnMouseLeave	(Inherited from Node.)
	OnMouseMove	(Inherited from Node.)
	OnMouseUp	(Inherited from Node.)
	OnMouseWheel	(Inherited from Node.)
	OnPropertyChanged	(Inherited from Node.)
	RaiseMouseClick	(Inherited from Node.)
	RaiseMouseDoubleClick	(Inherited from Node.)
	RaiseMouseDown	(Inherited from Node.)
	RaiseMouseEnter	(Inherited from Node.)
	RaiseMouseLeave	(Inherited from Node.)
	RaiseMouseMove	(Inherited from Node.)
	RaiseMouseUp	(Inherited from Node.)
	RaiseMouseWheel	(Inherited from Node.)
	Remove	Remove a node from this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Rotate(Quaternion)	Rotate this subtree by quaternion [ILNumerics Visualization Engine] (Inherited from Group.)
	Rotate(Vector3, Double)	Rotate this subtree by rotation axis and angle [ILNumerics Visualization Engine] (Inherited from Group.)
	Rotate(Double, Double, Double, Double)	Rotate this subtree by rotation axis and angle [ILNumerics Visualization Engine] (Inherited from Group.)
	Scale(Vector3)	Scales this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Scale(Double, Double, Double)	Scales this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Synchronize	(Inherited from Group.)
	SynchronizeChildren	(Inherited from Group.)
	ToString	String representation of the group node [ILNumerics Visualization Engine] (Inherited from Group.)
	Translate(Vector3)	Translates this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Translate(Double, Double, Double)	Translates this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	VisitInternal	(Inherited from Group.)

Top

Events

	Name	Description
	Disposing	Fires, before the node is getting disposed [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseClick	Fires when the object is clicked [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseDoubleClick	Fires when the object was double clicked [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseDown	Fires when a mouse button was pressed over the object [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseEnter	Fires when the mouse enters the object region [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseLeave	Fires when the mouse leaves the object region [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseMove	Fires when the mouse was moved over the object [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseUp	Fires when a mouse button was released over the object [ILNumerics Visualization Engine] (Inherited from Node.)
	MouseWheel	Fires when the mouse wheel was moved over the object [ILNumerics Visualization Engine] (Inherited from Node.)
	PropertyChanged	Fires on any property state changes [ILNumerics Visualization Engine] (Inherited from Node.)

Top

Fields

	Name	Description
	Arrow3DDefaultTag	Default tag used to identify arrow objects in the scene: "Arrow3D".
	BodyGroupDefaultTag	Default tag used to identify the body of the arrow in the scene: "Body".
	BottomBorderDefaultTag	Default tag used to identify the bottom border of the cylinder in the scene: "BottomBorder".
	BottomDefaultTag	Default tag used to identify the bottom of the cylinder in the scene: "CylinderBottom".
	ConeBottomDefaultTag	Default tag used to identify the cone bottom in the scene: "ConeBottom".
	ConeHullBorderDefaultTag	Default tag used to identify the cone hull border in the scene: "ConeHullBorder".
	ConeHullDefaultTag	Default tag used to identify the cone hull in the scene: "ConeHull".
	CylinderDefaultTag	Default tag used to identify the cylinder hull in the scene: "HullCylinder".
	HeadGroupDefaultTag	Default tag used to identify the head of the arrow in the scene: "Head".
	m_animations	(Inherited from Group.)
	m_children	(Inherited from Group.)
	m_timeoutAware	(Inherited from Group.)

Top

Remarks

The arrow head is assembled out of a cone, a disc and a lines shape for the border of the arrow head. The body is made out of a cylinder, a disc and a line for the bottom border.

The arrow has a body length of 1, a bottom radius of 1 with the midpoint at the origin, the head of radius 1.5 and a height of 0.4.

All parts of the arrow are separately accessible and configurable by individual properties: ConeHull, ConeBorder, ConeBottom, Body, Bottom, BottomBorder. Head and body are placed into separate group node, so they can get transformed arbitrarly.

[ILNumerics Visualization Engine]

Reference

ILNumerics.Drawing Namespace