ILNumerics Ultimate VS

TickCollection Class

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
The class represents the collection of ticks for axis objects and is used in PlotCube

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.Drawing.PlottingTickCollection

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

[SerializableAttribute]
public class TickCollection : Group, 
	IEnumerable<Tick>, IEnumerable

The TickCollection type exposes the following members.

Constructors

  NameDescription
Public methodTickCollection
Initializes a new instance of the TickCollection class
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]

(Inherited from Group.)
Public propertyAnimations (Inherited from Group.)
Public propertyChildren
Collection of child for this group

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyClipping
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.)
Public propertyColor
Gets the color for the lines of the ticks and the main axis line or sets it.

[ILNumerics Visualization Engine]

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

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public propertyCount
Gets the current number of ticks in the collection (readonly)

[ILNumerics Visualization Engine]

Public propertyDefaultLabel
The label template used to create new tick labels; provides all settings (color, font, ...)

[ILNumerics Visualization Engine]

Public propertyDefaultTickLabelSize
Gets the default size of tick labels in pixels or sets it. Default: actual size of [!:TickSizeMeasureDefaultTemplate] with [!:DefaultLabel.Font].

[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 propertyItem
Retrieve a single tick by index; to be used in Manual Tick Mode only!

[ILNumerics Visualization Engine]

Public propertyLengthLevelFraction
Gets/sets the fraction used to modify the lenght of the ticks for every tick level. Default: 0.5f

[ILNumerics Visualization Engine]

Public propertyLines
Access to the Lines shape used for drawing the tick lines

[ILNumerics Visualization Engine]

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 propertyMaxNumberDigitsShowFull
Threshold on number of digits allowed for a tick label before it gets abbreviated and the scale label is shown. Default: 5

[ILNumerics Visualization Engine]

Public propertyMode
Gets the tick creation mode or sets it

[ILNumerics Visualization Engine]

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]

(Inherited from Group.)
Public propertyTickLength
Gets/sets the length of the ticks; negative values: flip ticks inside plot cube; unit: fraction of DefaultFont height; default: 0.5f

[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]

(Inherited from Group.)
Public propertyTransform
[4x4] matrix with the affine transforms which this node applies to all children

[ILNumerics Visualization Engine]

(Inherited from Group.)
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.)
Public propertyWidth
Gets the thickness of the tick lines or sets it

[ILNumerics Visualization Engine]

Top
Methods

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

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodAdd(Tick)
Add a new tick to the tick collection

[ILNumerics Visualization Engine]

Public methodAdd(Single, Label)
Add a new tick to the tick collection by providing position and a label instance

[ILNumerics Visualization Engine]

Public methodAdd(Single, String)
Add a new tick to the tick collection by providing position and a label text

[ILNumerics Visualization Engine]

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

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodBeginVisit
pushes the transform, alpha and color overrides of this node to the render parameter stack

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodClear
Remove all ticks from the tick collection

[ILNumerics Visualization Engine]

Public methodConfigure
Configure the subtree after changes to any buffer

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodCopy (Overrides GroupCopy.)
Protected methodCreateSynchedCopy (Overrides GroupCreateSynchedCopy(Node).)
Public methodStatic memberCreateTicksAuto(Single, Single, Int32)
Default ticks creation function, produce nice numbers for linear axes

[ILNumerics Visualization Engine]

Public methodStatic memberCreateTicksAuto(Single, Single, Int32, Axis, AxisScale)
Create nice numbers for ticks for arbitrary axes

[ILNumerics Visualization Engine]

Public methodDetach
Detach all shapes from this subtree for individual configurations

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodDispose
Dispose the complete subtree (this is rarely needed)

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodEndVisit
pops the render parameter from render parameter stack

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFind(Object, NullablePrimitives)
Searches the subtree for nodes with matching tag and (optional) primitive type

[ILNumerics Visualization Engine]

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

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFindByIdT
Finds a typed node in this subtree, filter by ID

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFirstT
Gets first node with matching criteria from subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodFirstUpT
Finds a group node on the path up to root

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodGetEnumerator
Give an enumerator for this tick collection, allows the use inside foreach constructs

[ILNumerics Visualization Engine]

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

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodgetLimitsInternal (Inherited from Group.)
Public methodInsertT
Insert a node into the child collection at predefined index

[ILNumerics Visualization Engine]

(Inherited from Group.)
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]

(Inherited from Group.)
Public methodReplace(IEnumerableSingle)
Replace all existing ticks with a collection of new ticks; does not change current tick Mode

[ILNumerics Visualization Engine]

Public methodReplace(IEnumerableTick)
Replace all existing ticks with a collection of new ticks; does not change current tick Mode

[ILNumerics Visualization Engine]

Public methodRotate(Quaternion)
Rotate this subtree by quaternion

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodRotate(Vector3, Double)
Rotate this subtree by rotation axis and angle

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodRotate(Double, Double, Double, Double)
Rotate this subtree by rotation axis and angle

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodScale(Vector3)
Scales this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodScale(Double, Double, Double)
Scales this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodSynchronize (Overrides GroupSynchronize(Node, SyncParams).)
Protected methodSynchronizeChildren (Overrides GroupSynchronizeChildren(SyncParams, Group).)
Public methodToString
String representation of the group node

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodTranslate(Vector3)
Translates this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Public methodTranslate(Double, Double, Double)
Translates this subtree

[ILNumerics Visualization Engine]

(Inherited from Group.)
Protected methodVisitInternal (Inherited from Group.)
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
Public fieldStatic memberDefaultFontFunc
Font creation function used for initial fonts for tick labels; default: gives the default font for all labels (Helvetica, 10pt)
Public fieldStatic memberDefaultLabelTransformFunc
Default function used to transform tick positions into tick label texts. It applies a simple number transform, taking the current culture into account.
Public fieldStatic memberDefaultTickCreationFunc Obsolete.
Default tick creation function for all axis objects with TickMode set to Automatic.
Public fieldLabelTransformFunc
Function used to control the creation of tick labels from position values. Default: DefaultLabelTransformFunc
Protected fieldm_animations (Inherited from Group.)
Protected fieldm_children (Inherited from Group.)
Protected fieldm_timeoutAware (Inherited from Group.)
Public fieldTickCreationFunc Obsolete.
Function used to control the creation of ticks for this axis. Default: DefaultTickCreationFunc
Public fieldTickCreationFuncEx
Function used to control the creation of ticks for this axis. Default: CreateTicksAuto(Single, Single, Int32, Axis, AxisScale)
Public fieldStatic memberTickLabelTag
Tag identifying the tick label within the scene graph
Public fieldStatic memberTickLinesTag
Tag identifying the tick lines within the scene graph
Top
Remarks

[ILNumerics Visualization Engine]

See Also

Reference