Axis Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

The class implements an axis for displaying scaling information

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.Drawing.PlottingAxis

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

Syntax

Copy

[SerializableAttribute]
public class Axis : Group

<SerializableAttribute>
Public Class Axis
	Inherits Group

Dim instance As Axis

The Axis type exposes the following members.

Constructors

	Name	Description
	Axis	Copy constructor. [ILNumerics Visualization Engine]
	Axis(IAxisDataProvider, Object)	Default constructor. [ILNumerics Visualization Engine]

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.)
	AxisName	Get the type of the axis (XAxis, YAxis or ZAxis) or sets it [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.)
	DataProvider	The object providing neccessary data for this axis; default: first IAxisDataProvider on the path up to the root [ILNumerics Visualization Engine]
	DataProviderID	Gets/ sets the id of the data provider this axis retrieves its data from [ILNumerics Visualization Engine]
	Direction	The direction of the axis. Default: automatic setting according to the axis name (XAxis, YAxis or ZAxis) [ILNumerics Visualization Engine]
	GridMajor	Major grid lines for axes ticks [ILNumerics Visualization Engine]
	GridMinor	Minor grid lines for axes ticks [ILNumerics Visualization Engine]
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	IsSynchedNode	(Inherited from Node.)
	Label	Access the axis main label for configuration [ILNumerics Visualization Engine]
	LabelAnchor	Anchor for the main axis label, range: (0,0)..(1,1); null: automatic [ILNumerics Visualization Engine]
	LabelPosition	Default position of the label relative to the current axis position, size and orientation; null: automatic (default) [ILNumerics Visualization Engine]
	LabelRotation	Rotation for the main axis label; null: the label follows the axis orientation (default) [ILNumerics Visualization Engine]
	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.)
	Max	The maximum value for the axis range, if this property is not null, its value will override the actual value taken from the assigned data container within the plot cube. Default: null [ILNumerics Visualization Engine]
	Min	The minimum value for the axis range, if this property is not null, its value will override the actual value taken from the assigned data container within the plot cube. Default: null [ILNumerics Visualization Engine]
	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.)
	Position	Gets the axis position or sets it. The position is the start/lower end of the axis. null: automatic (default) [ILNumerics Visualization Engine]
	ScaleLabel	Access the axis scale label for configuration. [ILNumerics Visualization Engine]
	ScaleLabelAnchor	Anchor for the axis scale label, range: 0..1, null: automatic (default) [ILNumerics Visualization Engine]
	ScaleLabelPosition	Position of the scale label relative to the current axis position, size and orientation; null: automatic (default) [ILNumerics Visualization Engine]
	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.)
	Ticks	Access to the ticks collection group [ILNumerics Visualization Engine]
	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	Creates a copy of Axis. [ILNumerics Visualization Engine] (Overrides GroupCopy.)
	CreateSynchedCopy	Creates a synchronized copy of Axis. [ILNumerics Visualization Engine] (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	Synchronizes Axis. [ILNumerics Visualization Engine] (Overrides GroupSynchronize(Node, SyncParams).)
	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
	AxisGroupTag	Default node tag for new instances of Axis
	DefaultLabelPosition	The relative position of the axis main label, if LabelPosition is null. Default: follow axis at (0.5,1) (axis center, close to tick label)
	DefaultScaleLabelPosition	The relative position of the axis tick scale label, if ScaleLabelPosition is null. Default: follow axis at (1,1) (upper axis end, close to tick label)
	GridMajorLinesTag	Default node tag for new instances of axis' grid major lines, default: 'GridMajorLines'
	GridMinorLinesTag	Default node tag for new instances of axis' grid minor lines, default: 'GridMinorLines'
	LabelTag	Default node tag for new instances of axis' label, default: 'AxesLabel'
	m_animations	(Inherited from Group.)
	m_children	(Inherited from Group.)
	m_timeoutAware	(Inherited from Group.)
	ScaleLabelTag	Default node tag for new instances of axis' scale label, default: 'ScaleLabel'
	TickLabelMargin	Margin around tick labels as fraction of Ticks.DefaultLabel.Font.Height; default: 0.33f
	TickLabelPadding	Padding between individual ticks, default: 7
	TicksTag	Default node tag for new instances of axis' ticks collection, default: 'TicksCollectionGroup'

Top

Remarks

[ILNumerics Visualization Engine]

Reference

ILNumerics.Drawing.Plotting Namespace