FastSurface Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

A simple, yet rich surface object, focussing on performance of rendering and updates.

[ILNumerics Drawing2 Toolbox]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.Drawing.PlottingFastSurface

Namespace: ILNumerics.Drawing.Plotting
Assembly: ILNumerics.Toolboxes.Drawing2 (in ILNumerics.Toolboxes.Drawing2.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

Copy

public class FastSurface : Group, 
	IColormapProvider, IAxisDataProvider

Public Class FastSurface
	Inherits Group
	Implements IColormapProvider, IAxisDataProvider

Dim instance As FastSurface

The FastSurface type exposes the following members.

Constructors

	Name	Description
	FastSurface	Fast surface constructor, creates an empty surface. Use Update(InArraySingle, InArraySingle, InArraySingle, InArraySingle, Colormap, TupleSingle, Single, NullableVector3, NullableVector3, Boolean) on the created object for configuration! [ILNumerics Drawing2 Toolbox]

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.)
	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.)
	Colormap	Gets the current colormap [readonly]. [ILNumerics Drawing2 Toolbox]
	ColorOverride	If set, this color will override all individual colors in this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Columns	Number of columns configured [readonly]. [ILNumerics Drawing2 Toolbox]
	downscalingRecommended	[Experimental Phase] Displays whether downscaling is recommended or not [readonly]. [ILNumerics Drawing2 Toolbox]
	Fill	Gives a reference to the triangle strip shape of the surface fill (readonly, the shape itself is mutable). [ILNumerics Drawing2 Toolbox]
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	IsColormapped	Determine whether computations of colors are based on a colormap. Always returns true for FastSurface. [ILNumerics Drawing2 Toolbox]
	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.)
	MinMaxColorRange	Color value range used for mapping values to colors via the colormap [readonly]. [ILNumerics Drawing2 Toolbox]
	numberGridPoints	Indicates number of grid points used for downscaling. [ILNumerics Drawing2 Toolbox]
	OriginalColumns	Number of original columns [readonly]. [ILNumerics Drawing2 Toolbox]
	OriginalRows	Number of original rows [readonly]. [ILNumerics Drawing2 Toolbox]
	ParameterHasChanged
	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.)
	Rows	Number of rows configured [readonly]. [ILNumerics Drawing2 Toolbox]
	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	Method that is called in the beginning of the rendering process to interpolate the input parameter Z and the corresponding arrays X and Y according to the current view. [ILNumerics Drawing2 Toolbox] (Overrides GroupBeginVisit(RenderParameter).)
	Configure	Configure the subtree after changes to any buffer [ILNumerics Visualization Engine] (Inherited from Group.)
	Copy	Deep copy of this surface object to a new object, sharing buffers. [ILNumerics Drawing2 Toolbox] (Overrides GroupCopy.)
	CreateSynchedCopy	Creates a synchronized copy. [ILNumerics Drawing2 Toolbox] (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	Method that is called at the end of the rendering process to get the duration of the rendering process. [ILNumerics Drawing2 Toolbox] (Overrides GroupEndVisit(RenderParameter).)
	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	Computes new limits for FastSurface, if auto downscaling is enabled. [ILNumerics Drawing2 Toolbox] (Overrides GroupgetLimitsInternal(StackMatrix4, Limits, Boolean, NullableVector3).)
	GetRangeMaxValue	Gets the upper value limit corresponding to the upper bound of the colormap [readonly]. [ILNumerics Drawing2 Toolbox]
	GetRangeMinValue	Gets the lower value limit corresponding to the lower bound of the colormap [readonly]. [ILNumerics Drawing2 Toolbox]
	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.)
	ScaleMode	Gets the scale mode for the colorbar axis. This is always 'Linear'. [ILNumerics Drawing2 Toolbox]
	Synchronize	[Internal use] Synchronize this object with the rendering scene tree. [ILNumerics Drawing2 Toolbox] (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.)
	Update	Configure/ change/ update the surface data. [ILNumerics Drawing2 Toolbox]
	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
	DefaultFillTag	Default tag used for to identify the surface fil triangle shape in the scene: "FastSurfaceFill".
	DefaultTag	Default tag used to identidy the fast surface object in the scene: "FastSurface".
	m_animations	(Inherited from Group.)
	m_children	(Inherited from Group.)
	m_timeoutAware	(Inherited from Group.)

Top

Remarks

The FastSurface plot object offers a performant way of displaying 3 or 4 dimensional data on a 2 or 3 dimensional grid, involving the height (Z) coordinates and / or the colors of the grid tiles. Efficient updates to the data (including the shape, individual coordinates and/or individual colors) are possible.

In difference to Surface, FastSurface is not able to handle transparency and does not maintain a wireframe.

FastSurface objects are created empty and afterwards configured solely by the Update(InArraySingle, InArraySingle, InArraySingle, InArraySingle, Colormap, TupleSingle, Single, NullableVector3, NullableVector3, Boolean) method.

[ILNumerics Drawing2 Toolbox]

Reference

ILNumerics.Drawing.Plotting Namespace