Surface Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

A class used to create surface plots.

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.Drawing.PlottingSurface

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

Syntax

Copy

[SerializableAttribute]
public class Surface : Group, IColormapProvider, 
	IAxisDataProvider

<SerializableAttribute>
Public Class Surface
	Inherits Group
	Implements IColormapProvider, IAxisDataProvider

Dim instance As Surface

The Surface type exposes the following members.

Constructors

	Name	Description
	Surface(InArrayDouble, InArrayDouble, TupleSingle, Single, Colormap, Object)	Creates a new surface plot, provide Z, X and/or Y coordinates as double precision arrays (will be rounded internally) [ILNumerics Visualization Engine]
	Surface(InArraySingle, InArraySingle, TupleSingle, Single, Colormap, Object)	Creates a new surface plot, provide Z, X and/or Y coordinates [ILNumerics Visualization Engine]
	Surface(InArrayDouble, InArrayDouble, InArrayDouble, InArrayDouble, TupleSingle, Single, Colormap, Object)	Creates a new surface plot, provide Z values, X and Y ranges as double precision arrays (will be rounded internally) [ILNumerics Visualization Engine]
	Surface(InArraySingle, InArraySingle, InArraySingle, InArraySingle, TupleSingle, Single, Colormap, Object)	Creates a new surface plot, provide Z values, X and Y ranges [ILNumerics Visualization Engine]
	Surface(FuncSingle, Single, Single, Single, Single, Int32, Single, Single, Int32, FuncSingle, Single, Single, TupleSingle, Single, Colormap, Object)	Creates a new surface plot from a function delegate [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.)
	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 colormap used for coloring in colormapped modes or sets it [ILNumerics Visualization Engine]
	ColorMode	Gets or sets the current color mode. [ILNumerics Visualization Engine]
	ColorOverride	If set, this color will override all individual colors in this subtree [ILNumerics Visualization Engine] (Inherited from Group.)
	Colors	Gets the coloring values for this surface or sets them [ILNumerics Visualization Engine]
	Columns	Gets the number of columns currently held in the surface, readonly [ILNumerics Visualization Engine]
	DataRange	Gets or sets the current data range which corresponds to the current colormap [ILNumerics Visualization Engine]
	Fill	Gets a reference to the triangles shape representing the fill area of the surface [ILNumerics Visualization Engine]
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	IsColormapped	Indicates whether surface plot is colormapped or not [ILNumerics Visualization Engine]
	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.)
	Positions	Gets the positioning values for this surface or sets them [ILNumerics Visualization Engine]
	Rows	Gets the number of rows currently held in the surface, readonly [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.)
	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.)
	UseLighting	Determines, if the surface plot utilizes lighting. Default: Auto (true for individual color mode, false for colormap mode) [ILNumerics Visualization Engine]
	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.)
	Wireframe	Gets a reference to the lines shape representing the wireframes of the surface [ILNumerics Visualization Engine]

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.)
	Colormap_Changed
	Configure	Configure the subtree after changes to any buffer [ILNumerics Visualization Engine] (Inherited from Group.)
	Copy	Create a copy of the surface. This function is used internally. [ILNumerics Visualization Engine] (Overrides GroupCopy.)
	CreateSynchedCopy	(Overrides GroupCreateSynchedCopy(Node).)
	CreateWireframeSolid
	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.)
	GetRangeMaxValue
	GetRangeMinValue
	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.)
	Resize	Resize the grid size (number of rows and columns) [ILNumerics Visualization Engine]
	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
	Synchronize	(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.)
	UpdateColormapped	Update positions data [optional] and color data [optional], switch to colormapped mode. [ILNumerics Visualization Engine]
	UpdateRGBA	Update positions data [optional] and switches to solid coloring mode [ILNumerics Visualization Engine]
	UpdateSolidColor	Update positions data [optional] and switches to solid coloring mode [ILNumerics Visualization Engine]
	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
	FillTag	Default tag used to identify the fill area of surface plots in the scene: "SurfaceFill".
	m_animations	(Inherited from Group.)
	m_children	(Inherited from Group.)
	m_timeoutAware	(Inherited from Group.)
	SurfaceDefaultTag	Default Tag used to identify surface plot objects in the scene: "SurfaceDefaultTag".
	WireframeTag	Default tag used to identify the wire frame of surface plots in the scene: "SurfaceWireframe".

Top

Remarks

[ILNumerics Visualization Engine]

Reference

ILNumerics.Drawing.Plotting Namespace