Tripod Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

The tripod class adds support for rotation displays to arbitrary scenes.

[ILNumerics Visualization Engine]

Inheritance Hierarchy

SystemObject
  ILNumerics.DrawingNode
    ILNumerics.DrawingGroup
      ILNumerics.DrawingCamera
        ILNumerics.DrawingTripod

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

Syntax

Copy

public class Tripod : Camera

Public Class Tripod
	Inherits Camera

Dim instance As Tripod

The Tripod type exposes the following members.

Constructors

	Name	Description
	Tripod(Tripod)	Initializes a new instance of the Tripod class
	Tripod(Object, TripodStyle, CameraQuadrant, Single)	Create a new tripod to be added to a 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] (Inherited from Camera.)
	AllowRotation	Enable or disable the ability to rotate the camera content. Default: true (enabled) [ILNumerics Visualization Engine] (Inherited from Camera.)
	AllowZoom	Enable or disable the ability to zoom the camera content. Default: true (enabled) [ILNumerics Visualization Engine] (Inherited from Camera.)
	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] (Inherited from Camera.)
	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] (Inherited from Camera.)
	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] (Inherited from Camera.)
	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] (Inherited from Camera.)
	IsSynchedNode	(Inherited from Node.)
	LookAt	Point, the camera is aiming at (world coords) [ILNumerics Visualization Engine] (Inherited from Camera.)
	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] (Inherited from Camera.)
	Position	Get/set camera position, absolute cartesian coordinates [ILNumerics Visualization Engine] (Inherited from Camera.)
	PositionTransform	Get position transform matrix (readonly) [ILNumerics Visualization Engine] (Inherited from Camera.)
	Projection	Get the type of projection (orthographic/ perspective) or sets it [ILNumerics Visualization Engine] (Inherited from Camera.)
	ProjectionTransform	Get projection transform matrix (readonly) [ILNumerics Visualization Engine] (Inherited from Camera.)
	RotationCenter	The 3D coordinate of the current center for (interactive) rotation operations. [ILNumerics Visualization Engine] (Inherited from Camera.)
	ScreenRect	Screen rectangle identifying the area this object is using inside its container (0..1/0..1, get/set) [ILNumerics Visualization Engine] (Inherited from Camera.)
	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] (Inherited from Camera.)
	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] (Inherited from Camera.)
	Visible	Determines, if this node is visible or sets the visible state [ILNumerics Visualization Engine] (Inherited from Node.)
	XArrow	Gets the group implementing the content which is specific for the X axis [ILNumerics Visualization Engine]
	YArrow	Gets the group implementing the content which is specific for the Y axis [ILNumerics Visualization Engine]
	ZArrow	Gets the group implementing the content which is specific for the Z axis [ILNumerics Visualization Engine]
	ZFar	Far clipping limit (Z axis) [ILNumerics Visualization Engine] (Inherited from Camera.)
	ZNear	Near clipping limit (Z axis) [ILNumerics Visualization Engine] (Inherited from Camera.)
	ZoomFactor	Gets the zoom factor for this camera or sets it [ILNumerics Visualization Engine] (Inherited from Camera.)

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	(Overrides CameraBeginVisit(RenderParameter).)
	Configure	Configure the subtree after changes to any buffer [ILNumerics Visualization Engine] (Inherited from Group.)
	Copy	Create a shallow copy of this object [ILNumerics Visualization Engine] (Overrides CameraCopy.)
	CopyFrom	(Inherited from Camera.)
	CreateSynchedCopy	(Overrides CameraCreateSynchedCopy(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] (Inherited from Camera.)
	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] (Inherited from Camera.)
	OnDisposing	(Inherited from Node.)
	OnMouseClick	(Inherited from Node.)
	OnMouseDoubleClick	(Inherited from Camera.)
	OnMouseDown	(Inherited from Camera.)
	OnMouseEnter	(Inherited from Node.)
	OnMouseLeave	(Inherited from Node.)
	OnMouseMove	(Overrides CameraOnMouseMove(MouseEventArgs).)
	OnMouseUp	(Inherited from Node.)
	OnMouseWheel	(Overrides CameraOnMouseWheel(MouseEventArgs).)
	OnPropertyChanged	Fires a Changed event [ILNumerics Visualization Engine] (Inherited from Camera.)
	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] (Inherited from Camera.)
	Rotate(Quaternion)	Rotate the camera position based on the rotation stored in a quarternion [ILNumerics Visualization Engine] (Inherited from Camera.)
	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] (Inherited from Camera.)
	RotateY	Rotate the camera position to the left / rigth around the look at point, keep the same distance. [ILNumerics Visualization Engine] (Inherited from Camera.)
	RotateZ	Rotate the camera around the vector connecting the camera position with the center of rotation. [ILNumerics Visualization Engine] (Inherited from Camera.)
	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] (Inherited from Camera.)
	SynchronizeChildren	(Inherited from Group.)
	ToString	Convert all camera parameter to string [ILNumerics Visualization Engine] (Inherited from Camera.)
	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
	DefaultTag	The tag used to identify the tripod within a scene.
	m_allowPan	Boolean variable that is true, if panning is allowed, defautl: true. (Inherited from Camera.)
	m_allowRotation	Boolean variable that is true, if rotating is allowed, default: true: (Inherited from Camera.)
	m_allowZoom	Boolean variable that is true, if zooming is allowed, default: true. (Inherited from Camera.)
	m_animations	(Inherited from Group.)
	m_aspectRatioMode	The current aspect ratio mode. (Inherited from Camera.)
	m_children	(Inherited from Group.)
	m_isGlobal	Flag identifying the visibility scope of this camera. (Inherited from Camera.)
	m_mouseStartF	The coordinates where the mouse started a dragging operation. (Inherited from Camera.)
	m_timeoutAware	(Inherited from Group.)
	m_zoomFactor	Zoom factor, default: 1. (Inherited from Camera.)
	XArrowDefaultTag	The tag used to identify the X axis specific content of the tripod.
	YArrowDefaultTag	The tag used to identify the Y axis specific content of the tripod.
	ZArrowDefaultTag	The tag used to identify the Z axis specific content of the tripod.

Top

Remarks

A tripod visualizes the state of rotation of a subscene. The camera rotation is visualized by a small tripod, showing the current direction of X, Y and Z axes. The tripod rotation automatically follows the rotation of the main camera. Any translational or scaling /zoom transforms happening on the corresponding subscene are ignored.

The tripod is attached to a main camera by adding the Tripod class as a child to that camera. From now on the tripod will follow its rotation. Note that the tripod does not need to be a direct child of the camera. The tripod will recognize the rotation of the first camera which it finds on the path up to the root of the scene.

Tripod allows the full configuration flexibility of regular cameras: ScreenRect is used to define the screen rectangle the tripod is occupying. AspectRatio, Projection and even arbitrary Transforms can be configured as well.

Tripod provides some interactive capabilities: It allows to zoom in / out with the mouse wheel when the mouse is over the tripod. When the user drags the mouse with the left mouse button, the corresponding scene is rotated. If the dragging starts on one of the three axis identifier (the X-, Y- or Z-arrow with the Arrow3D style or the X-,Y- or Z label for the simple style) the rotation will become restricted to that specific axis only. When the Shift key is down, all interactions are greatly slowed down by a factor of 10. The interaction can be disabled for the end user by setting the AllowZoom and AllowRotation properties of the base class to false.

One can use Tripod as starting point for own custom tripod implementation. The constructor parameter Tripod(Object, TripodStyle, CameraQuadrant, Single) 'style' is used to define the style of the tripod. Set this to Empty in order to get an empty tripod group, keeping its functionality: It will rotate its (arbitrary) content according to the parent camera transformation. The example below demonstrates how this could be used to get an interactive thumbnail of a scene or parts of it. Another example is found in the Tripod_Configuration example.

[ILNumerics Visualization Engine]

Examples

Default Tripod

Copy

private void ilPanel1_Load(object sender, EventArgs e) {
    // some simple scene
    ilPanel1.Scene.Camera.Add(new Sphere());
    // add a tripod to the scene, following the main scenes rotation
    ilPanel1.Scene.Camera.Add(new Tripod()); 
}

Custom Tripod - create a shrinked copy of the main scene

Copy

private void ilPanel1_Load(object sender, EventArgs e) {
    // Create and add some scene content. We wrap it into a group just to 
    // have the scene available for easier copying later. 
    var group = ilPanel1.Scene.Camera.Add(new Group() {
        Shapes.Sphere2, Shapes.Gear25, Shapes.Gear25Wireframe
    }); 

    // Create and add a tripod right to the main camera. It could be added to any other camera as well.
    // Set the tripod style empty in order to prevent the standard (Arrow3D based) tripod to show up. 
    ilPanel1.Scene.Camera.Add(new Tripod(style: TripodStyle.TripodEmpty) {

        // place the tripod to upper left corner
        ScreenRect = new RectangleF(0.05f, 0.05f, 0.1f, 0.1f),

        // the tripod could be configured independently
        //AspectRatioMode = ILNumerics.Drawing.AspectRatioMode.StretchToFill,

        // Add custom content to the tripod: a scaled copy of the above scene
        Children = { 
            new Group(scale: new Vector3(.5,0.5,0.5)) { group }
        }
    }); 
}

Reference

ILNumerics.Drawing Namespace