ILNumerics Ultimate VS

Group Class

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Group holds and manages arbitrary nodes and serves as base class for custom visual object implementations

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      More...

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

[SerializableAttribute]
public class Group : Node, IEnumerable<Node>, 
	IEnumerable

The Group type exposes the following members.

Constructors

  NameDescription
Protected methodGroup(Group)
create a new group as shallow copy of a subtree, shared buffers

[ILNumerics Visualization Engine]

Public methodGroup(Object, NullableVector3, Double, NullableVector3, NullableVector3, NullableRenderTarget)
Creates a new empty group

[ILNumerics Visualization Engine]

Top
Properties

  NameDescription
Public propertyAlpha
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]

Public propertyAnimations
Public propertyChildren
Collection of child for this group

[ILNumerics Visualization Engine]

Public propertyClipping
Gets all 6 available clipping planes for the group or sets it. Null: derive clipping from parent node (default)

[ILNumerics Visualization Engine]

Public propertyColorOverride
If set, this color will override all individual colors in this subtree

[ILNumerics Visualization Engine]

Public propertyID
Unique ID for the node within the scene

[ILNumerics Visualization Engine]

(Inherited from Node.)
Protected propertyIsSynchedNode (Inherited from Node.)
Public propertyMarkable
Determines, if this node can be marked by the user

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyMarked
Marked state for the node

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyParent
Get the parent of this node or null, if this node is a root node

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyPickingID
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.)
Protected propertySynchedVersion
The version of the sync source from the last synchronization.

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyTag
Object tag used to identify the node within the scene

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyTarget
If set, determines the target for rendering: world (3D) or screen (2D) on top. Default: not set (derive from parent)

[ILNumerics Visualization Engine]

Public propertyTimeoutAware
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]

Public propertyTransform
[4x4] matrix with the affine transforms which this node applies to all children

[ILNumerics Visualization Engine]

Public propertyVersion
Modification version of this node, gets incremented at every change

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public propertyVisible
Determines, if this node is visible or sets the visible state

[ILNumerics Visualization Engine]

(Inherited from Node.)
Top
Methods

  NameDescription
Public methodAdd(Node)
Add a node to the end of this groups child collection

[ILNumerics Visualization Engine]

Public methodAddT(T, Object, Boolean)
Add a node to the end of this groups child collection

[ILNumerics Visualization Engine]

Protected methodBeginVisit
pushes the transform, alpha and color overrides of this node to the render parameter stack

[ILNumerics Visualization Engine]

(Overrides NodeBeginVisit(RenderParameter).)
Public methodConfigure
Configure the subtree after changes to any buffer

[ILNumerics Visualization Engine]

(Overrides NodeConfigure(Boolean, Boolean).)
Public methodCopy
Create a shallow copy of this subtree

[ILNumerics Visualization Engine]

(Overrides NodeCopy.)
Protected methodCreateSynchedCopy (Overrides NodeCreateSynchedCopy(Node).)
Public methodDetach
Detach all shapes from this subtree for individual configurations

[ILNumerics Visualization Engine]

(Overrides NodeDetach.)
Public methodDispose
Dispose the complete subtree (this is rarely needed)

[ILNumerics Visualization Engine]

(Overrides NodeDispose.)
Protected methodEndVisit
pops the render parameter from render parameter stack

[ILNumerics Visualization Engine]

(Overrides NodeEndVisit(RenderParameter).)
Public methodFind(Object, NullablePrimitives)
Searches the subtree for nodes with matching tag and (optional) primitive type

[ILNumerics Visualization Engine]

Public methodFindT(Object, PredicateT)
Searches the subtree for all nodes with matching criteria

[ILNumerics Visualization Engine]

Public methodFindByIdT
Finds a typed node in this subtree, filter by ID

[ILNumerics Visualization Engine]

Public methodFirstT
Gets first node with matching criteria from subtree

[ILNumerics Visualization Engine]

Public methodFirstUpT
Finds a group node on the path up to root

[ILNumerics Visualization Engine]

Public methodGetEnumerator
Public methodGetLimits
Compute the 3D limits (extent) of this subtree

[ILNumerics Visualization Engine]

Protected methodgetLimitsInternal
Public methodInsertT
Insert a node into the child collection at predefined index

[ILNumerics Visualization Engine]

Protected methodOnDisposing (Inherited from Node.)
Protected methodOnMouseClick (Inherited from Node.)
Protected methodOnMouseDoubleClick (Inherited from Node.)
Protected methodOnMouseDown (Inherited from Node.)
Protected methodOnMouseEnter (Inherited from Node.)
Protected methodOnMouseLeave (Inherited from Node.)
Protected methodOnMouseMove (Inherited from Node.)
Protected methodOnMouseUp (Inherited from Node.)
Protected methodOnMouseWheel (Inherited from Node.)
Protected methodOnPropertyChanged (Inherited from Node.)
Protected methodRaiseMouseClick (Inherited from Node.)
Protected methodRaiseMouseDoubleClick (Inherited from Node.)
Protected methodRaiseMouseDown (Inherited from Node.)
Protected methodRaiseMouseEnter (Inherited from Node.)
Protected methodRaiseMouseLeave (Inherited from Node.)
Protected methodRaiseMouseMove (Inherited from Node.)
Protected methodRaiseMouseUp (Inherited from Node.)
Protected methodRaiseMouseWheel (Inherited from Node.)
Public methodRemove
Remove a node from this subtree

[ILNumerics Visualization Engine]

Public methodRotate(Quaternion)
Rotate this subtree by quaternion

[ILNumerics Visualization Engine]

Public methodRotate(Vector3, Double)
Rotate this subtree by rotation axis and angle

[ILNumerics Visualization Engine]

Public methodRotate(Double, Double, Double, Double)
Rotate this subtree by rotation axis and angle

[ILNumerics Visualization Engine]

Public methodScale(Vector3)
Scales this subtree

[ILNumerics Visualization Engine]

Public methodScale(Double, Double, Double)
Scales this subtree

[ILNumerics Visualization Engine]

Public methodSynchronize (Overrides NodeSynchronize(Node, SyncParams).)
Protected methodSynchronizeChildren
Public methodToString
String representation of the group node

[ILNumerics Visualization Engine]

(Overrides NodeToString.)
Public methodTranslate(Vector3)
Translates this subtree

[ILNumerics Visualization Engine]

Public methodTranslate(Double, Double, Double)
Translates this subtree

[ILNumerics Visualization Engine]

Protected methodVisitInternal (Overrides NodeVisitInternal(RenderParameter).)
Top
Events

  NameDescription
Public eventDisposing
Fires, before the node is getting disposed

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseClick
Fires when the object is clicked

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseDoubleClick
Fires when the object was double clicked

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseDown
Fires when a mouse button was pressed over the object

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseEnter
Fires when the mouse enters the object region

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseLeave
Fires when the mouse leaves the object region

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseMove
Fires when the mouse was moved over the object

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseUp
Fires when a mouse button was released over the object

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventMouseWheel
Fires when the mouse wheel was moved over the object

[ILNumerics Visualization Engine]

(Inherited from Node.)
Public eventPropertyChanged
Fires on any property state changes

[ILNumerics Visualization Engine]

(Inherited from Node.)
Top
Fields

  NameDescription
Protected fieldm_animations
Protected fieldm_children
Protected fieldm_timeoutAware
Top
Remarks

[ILNumerics Visualization Engine]

See Also

Reference

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.DrawingArrow3D
      ILNumerics.DrawingCamera
      ILNumerics.DrawingCircle
      ILNumerics.DrawingCone
      ILNumerics.DrawingCylinder
      ILNumerics.DrawingDynamicGroup
      ILNumerics.DrawingEditor
      ILNumerics.DrawingGear
      ILNumerics.Drawing.PlottingAutoSizeGroup
      ILNumerics.Drawing.PlottingAxis
      ILNumerics.Drawing.PlottingAxisCollection
      ILNumerics.Drawing.PlottingBarPlot
      ILNumerics.Drawing.PlottingBarPlotEx
      ILNumerics.Drawing.PlottingBoxPlot
      ILNumerics.Drawing.PlottingCandlestick
      ILNumerics.Drawing.PlottingContourLine
      ILNumerics.Drawing.PlottingContourPlot
      ILNumerics.Drawing.PlottingErrorBarPlot
      ILNumerics.Drawing.PlottingFastSurface
      ILNumerics.Drawing.PlottingFillArea
      ILNumerics.Drawing.PlottingImageSCPlot
      ILNumerics.Drawing.PlottingLegendItem
      ILNumerics.Drawing.PlottingLinePlot
      ILNumerics.Drawing.PlottingMarker
      ILNumerics.Drawing.PlottingPlotCubeDataGroup
      ILNumerics.Drawing.PlottingPlotCubeScaleGroup
      ILNumerics.Drawing.PlottingSelectionRectangle
      ILNumerics.Drawing.PlottingSmoothSurface
      ILNumerics.Drawing.PlottingStackedAreaPlot
      ILNumerics.Drawing.PlottingSurface
      ILNumerics.Drawing.PlottingTickCollection
      ILNumerics.DrawingRoundedRectangle
      ILNumerics.DrawingScene
      ILNumerics.DrawingScreenObject
      ILNumerics.DrawingSelectionBox
      ILNumerics.DrawingSphere