Camera Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

This class implements a virtual camera, capable of positioning and orienting a 3D scene.

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.DrawingCamera
        ILNumerics.Drawing.PlottingPlotCube
        ILNumerics.DrawingTripod

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

Syntax

Copy

[SerializableAttribute]
public class Camera : Group

<SerializableAttribute>
Public Class Camera
	Inherits Group

Dim instance As Camera

The Camera type exposes the following members.

Constructors

	Name	Description
	Camera(Object)	Creates a new camera [ILNumerics Visualization Engine]
	Camera(Camera)	Create new camera, copy settings from existing camera [ILNumerics Visualization Engine]

Top

Properties

	Name	Description
	AllowPan	Enable or disable the ability to move the camera content with right mouse dragging. Default: true (enabled) [ILNumerics Visualization Engine]
	AllowRotation	Enable or disable the ability to rotate the camera content. Default: true (enabled) [ILNumerics Visualization Engine]
	AllowZoom	Enable or disable the ability to zoom the camera content. Default: true (enabled) [ILNumerics Visualization Engine]
	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.)
	AspectRatioMode	Determines, if objects keep their shape, regardless from the windows aspect ratio or rotation context. Default: maintain ratios. [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.)
	FieldOfView	Determines the field of view for perspective projection. Small: more fish eye effect, large: more overview. Default: 10 [ILNumerics Visualization Engine]
	ID	Unique ID for the node within the scene [ILNumerics Visualization Engine] (Inherited from Node.)
	Is2DView	True, when looking from top on the un-rotated scene (common for 2D plots) [ILNumerics Visualization Engine]
	IsGlobal	Determine if this camera is acting on the global scene. Changes made to one driver will affect all instances of the same camera/scene for all drivers. [ILNumerics Visualization Engine]
	IsSynchedNode	(Inherited from Node.)
	LookAt	Point, the camera is aiming at (world coords) [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.)
	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.)
	Polar	Spherical coordinates relative to the look at point [ILNumerics Visualization Engine]
	Position	Get/set camera position, absolute cartesian coordinates [ILNumerics Visualization Engine]
	PositionTransform	Get position transform matrix (readonly) [ILNumerics Visualization Engine]
	Projection	Get the type of projection (orthographic/ perspective) or sets it [ILNumerics Visualization Engine]
	ProjectionTransform	Get projection transform matrix (readonly) [ILNumerics Visualization Engine]
	RotationCenter	The 3D coordinate of the current center for (interactive) rotation operations. [ILNumerics Visualization Engine]
	ScreenRect	Screen rectangle identifying the area this object is using inside its container (0..1/0..1, get/set) [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.)
	Top	Orientation of the camera, normalized, readonly [ILNumerics Visualization Engine]
	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.)
	ViewTransform	Gets the view transformation matrix mapping the rendering area for this camera (ScreenRect) to clip coordinates (readonly). [ILNumerics Visualization Engine]
	Visible	Determines, if this node is visible or sets the visible state [ILNumerics Visualization Engine] (Inherited from Node.)
	ZFar	Far clipping limit (Z axis) [ILNumerics Visualization Engine]
	ZNear	Near clipping limit (Z axis) [ILNumerics Visualization Engine]
	ZoomFactor	Gets the zoom factor for this camera or sets it [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	In a derived class allows to implement custom logic to be executed before the rendering starts. [ILNumerics Visualization Engine] (Overrides GroupBeginVisit(RenderParameter).)
	Configure	Configure the subtree after changes to any buffer [ILNumerics Visualization Engine] (Inherited from Group.)
	Copy	Creates a copy of Camera. [ILNumerics Visualization Engine] (Overrides GroupCopy.)
	CopyFrom
	CreateSynchedCopy	Creates a synchronized copy of Camera. [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	In a derived class allows to implement custom logic for reacting on the end of visiting this node. [ILNumerics Visualization Engine] (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	(Inherited from Group.)
	InsertT	Insert a node into the child collection at predefined index [ILNumerics Visualization Engine] (Inherited from Group.)
	Move	Move the camera position according to a distance given in clip coordinates [ILNumerics Visualization Engine]
	OnDisposing	(Inherited from Node.)
	OnMouseClick	(Inherited from Node.)
	OnMouseDoubleClick	(Overrides NodeOnMouseDoubleClick(MouseEventArgs).)
	OnMouseDown	(Overrides NodeOnMouseDown(MouseEventArgs).)
	OnMouseEnter	(Inherited from Node.)
	OnMouseLeave	(Inherited from Node.)
	OnMouseMove	(Overrides NodeOnMouseMove(MouseEventArgs).)
	OnMouseUp	(Inherited from Node.)
	OnMouseWheel	(Overrides NodeOnMouseWheel(MouseEventArgs).)
	OnPropertyChanged	Fires a Changed event [ILNumerics Visualization Engine] (Overrides NodeOnPropertyChanged(String).)
	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.)
	Reset	Resets Camera. [ILNumerics Visualization Engine]
	Rotate(Quaternion)	Rotate the camera position based on the rotation stored in a quarternion [ILNumerics Visualization Engine]
	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.)
	RotateX	Move the camera position forward around the look at point, keep the same distance. [ILNumerics Visualization Engine]
	RotateY	Rotate the camera position to the left / rigth around the look at point, keep the same distance. [ILNumerics Visualization Engine]
	RotateZ	Rotate the camera around the vector connecting the camera position with the center of rotation. [ILNumerics Visualization Engine]
	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 Camera. [ILNumerics Visualization Engine] (Overrides GroupSynchronize(Node, SyncParams).)
	SynchronizeChildren	(Inherited from Group.)
	ToString	Convert all camera parameter to string [ILNumerics Visualization Engine] (Overrides GroupToString.)
	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
	Default	Default camera instance
	m_allowPan	Boolean variable that is true, if panning is allowed, defautl: true.
	m_allowRotation	Boolean variable that is true, if rotating is allowed, default: true:
	m_allowZoom	Boolean variable that is true, if zooming is allowed, default: true.
	m_animations	(Inherited from Group.)
	m_aspectRatioMode	The current aspect ratio mode.
	m_children	(Inherited from Group.)
	m_isGlobal	Flag identifying the visibility scope of this camera.
	m_mouseStartF	The coordinates where the mouse started a dragging operation.
	m_timeoutAware	(Inherited from Group.)
	m_zoomFactor	Zoom factor, default: 1.

Top

Remarks

[ILNumerics Visualization Engine]

Reference

ILNumerics.Drawing Namespace