Table of Contents

Class HelixViewport3D

Namespace
HelixToolkit.Wpf
Assembly
HelixToolkit.Wpf.dll

A control that contains a Viewport3D and a CameraController.

[TemplatePart(Name = "PART_CameraController", Type = typeof(CameraController))]
[TemplatePart(Name = "PART_ViewportGrid", Type = typeof(Grid))]
[TemplatePart(Name = "PART_AdornerLayer", Type = typeof(AdornerDecorator))]
[TemplatePart(Name = "PART_CoordinateView", Type = typeof(Viewport3D))]
[TemplatePart(Name = "PART_ViewCubeViewport", Type = typeof(Viewport3D))]
[Localizability(LocalizationCategory.NeverLocalize)]
public class HelixViewport3D : ItemsControl, IAnimatable, ISupportInitialize, IFrameworkInputElement, IInputElement, IQueryAmbient, IContainItemStorage, IAddChild, IHelixViewport3D
Inheritance
HelixViewport3D
Implements
Inherited Members
Extension Methods

Constructors

HelixViewport3D()

Initializes a new instance of the HelixViewport3D class.

public HelixViewport3D()

Fields

BackViewGestureProperty

Identifies the BackViewGesture dependency property.

public static readonly DependencyProperty BackViewGestureProperty

Field Value

DependencyProperty

BottomViewGestureProperty

Identifies the BottomViewGesture dependency property.

public static readonly DependencyProperty BottomViewGestureProperty

Field Value

DependencyProperty

CameraChangedEvent

The camera changed event.

public static readonly RoutedEvent CameraChangedEvent

Field Value

RoutedEvent

CameraInertiaFactorProperty

Identifies the CameraInertiaFactor dependency property.

public static readonly DependencyProperty CameraInertiaFactorProperty

Field Value

DependencyProperty

CameraInfoProperty

Identifies the CameraInfo dependency property.

public static readonly DependencyProperty CameraInfoProperty

Field Value

DependencyProperty

CameraModeProperty

Identifies the CameraMode dependency property.

public static readonly DependencyProperty CameraModeProperty

Field Value

DependencyProperty

CameraRotationModeProperty

Identifies the CameraRotationMode dependency property.

public static readonly DependencyProperty CameraRotationModeProperty

Field Value

DependencyProperty

ChangeFieldOfViewCursorProperty

Identifies the ChangeFieldOfViewCursor dependency property.

public static readonly DependencyProperty ChangeFieldOfViewCursorProperty

Field Value

DependencyProperty

ChangeFieldOfViewGestureProperty

Identifies the ChangeFieldOfViewGesture dependency property.

public static readonly DependencyProperty ChangeFieldOfViewGestureProperty

Field Value

DependencyProperty

ChangeLookAtGestureProperty

Identifies the ChangeLookAtGesture dependency property.

public static readonly DependencyProperty ChangeLookAtGestureProperty

Field Value

DependencyProperty

ConstructionPlaneProperty

Identifies the ConstructionPlane dependency property.

public static readonly DependencyProperty ConstructionPlaneProperty

Field Value

DependencyProperty

CoordinateSystemHeightProperty

Identifies the CoordinateSystemHeight dependency property.

public static readonly DependencyProperty CoordinateSystemHeightProperty

Field Value

DependencyProperty

CoordinateSystemHorizontalPositionProperty

Identifies the CoordinateSystemHorizontalPosition dependency property.

public static readonly DependencyProperty CoordinateSystemHorizontalPositionProperty

Field Value

DependencyProperty

CoordinateSystemLabelForegroundProperty

Identifies the CoordinateSystemLabelForeground dependency property.

public static readonly DependencyProperty CoordinateSystemLabelForegroundProperty

Field Value

DependencyProperty

CoordinateSystemLabelXProperty

Identifies the CoordinateSystemLabelX dependency property.

public static readonly DependencyProperty CoordinateSystemLabelXProperty

Field Value

DependencyProperty

CoordinateSystemLabelYProperty

Identifies the CoordinateSystemLabelY dependency property.

public static readonly DependencyProperty CoordinateSystemLabelYProperty

Field Value

DependencyProperty

CoordinateSystemLabelZProperty

Identifies the CoordinateSystemLabelZ dependency property.

public static readonly DependencyProperty CoordinateSystemLabelZProperty

Field Value

DependencyProperty

CoordinateSystemVerticalPositionProperty

Identifies the CoordinateSystemVerticalPosition dependency property.

public static readonly DependencyProperty CoordinateSystemVerticalPositionProperty

Field Value

DependencyProperty

CoordinateSystemWidthProperty

Identifies the CoordinateSystemWidth dependency property.

public static readonly DependencyProperty CoordinateSystemWidthProperty

Field Value

DependencyProperty

CursorOnConstructionPlanePositionProperty

Identifies the CursorOnConstructionPlanePosition dependency property.

public static readonly DependencyProperty CursorOnConstructionPlanePositionProperty

Field Value

DependencyProperty

Remarks

This property returns the point on the cursor plane..

CursorOnElementPositionProperty

Identifies the CursorOnElementPosition dependency property.

public static readonly DependencyProperty CursorOnElementPositionProperty

Field Value

DependencyProperty

Remarks

This property returns the position of the nearest model.

CursorPositionProperty

Identifies the CursorPosition dependency property.

public static readonly DependencyProperty CursorPositionProperty

Field Value

DependencyProperty

Remarks

The return value equals ConstructionPlanePosition or CursorModelSnapPosition if CursorSnapToModels is not null.

CursorRayProperty

Identifies the CursorRay dependency property.

public static readonly DependencyProperty CursorRayProperty

Field Value

DependencyProperty

DebugInfoProperty

Identifies the DebugInfo dependency property.

public static readonly DependencyProperty DebugInfoProperty

Field Value

DependencyProperty

DefaultCameraProperty

Identifies the DefaultCamera dependency property.

public static readonly DependencyProperty DefaultCameraProperty

Field Value

DependencyProperty

EnableCursorPositionProperty

Identifies the EnableCursorPosition dependency property. It enables (true) or disables (false) the calculation of the cursor position in the 3D Viewport

public static readonly DependencyProperty EnableCursorPositionProperty

Field Value

DependencyProperty

FieldOfViewTextProperty

Identifies the FieldOfViewText dependency property.

public static readonly DependencyProperty FieldOfViewTextProperty

Field Value

DependencyProperty

FixedRotationPointEnabledProperty

Identifies the FixedRotationPointEnabled dependency property.

public static readonly DependencyProperty FixedRotationPointEnabledProperty

Field Value

DependencyProperty

FixedRotationPointProperty

Identifies the FixedRotationPoint dependency property.

public static readonly DependencyProperty FixedRotationPointProperty

Field Value

DependencyProperty

FrameRateProperty

Identifies the FrameRate dependency property.

public static readonly DependencyProperty FrameRateProperty

Field Value

DependencyProperty

FrameRateTextProperty

Identifies the FrameRateText dependency property.

public static readonly DependencyProperty FrameRateTextProperty

Field Value

DependencyProperty

FrontViewGestureProperty

Identifies the FrontViewGesture dependency property.

public static readonly DependencyProperty FrontViewGestureProperty

Field Value

DependencyProperty

InfiniteSpinProperty

Identifies the InfiniteSpin dependency property.

public static readonly DependencyProperty InfiniteSpinProperty

Field Value

DependencyProperty

InfoBackgroundProperty

Identifies the InfoBackground dependency property.

public static readonly DependencyProperty InfoBackgroundProperty

Field Value

DependencyProperty

InfoForegroundProperty

Identifies the InfoForeground dependency property.

public static readonly DependencyProperty InfoForegroundProperty

Field Value

DependencyProperty

IsChangeFieldOfViewEnabledProperty

Identifies the IsChangeFieldOfViewEnabled dependency property.

public static readonly DependencyProperty IsChangeFieldOfViewEnabledProperty

Field Value

DependencyProperty

IsHeadlightEnabledProperty

Identifies the IsHeadLightEnabled dependency property.

public static readonly DependencyProperty IsHeadlightEnabledProperty

Field Value

DependencyProperty

IsInertiaEnabledProperty

Identifies the IsInertiaEnabled dependency property.

public static readonly DependencyProperty IsInertiaEnabledProperty

Field Value

DependencyProperty

IsMoveEnabledProperty

Identifies the IsMoveEnabled dependency property.

public static readonly DependencyProperty IsMoveEnabledProperty

Field Value

DependencyProperty

IsPanEnabledProperty

Identifies the IsPanEnabled dependency property.

public static readonly DependencyProperty IsPanEnabledProperty

Field Value

DependencyProperty

IsRotationEnabledProperty

Identifies the IsRotationEnabled dependency property.

public static readonly DependencyProperty IsRotationEnabledProperty

Field Value

DependencyProperty

IsTopBottomViewOrientedToFrontBackProperty

Identifies the IsTopBottomViewOrientedToFrontBack dependency property.

public static readonly DependencyProperty IsTopBottomViewOrientedToFrontBackProperty

Field Value

DependencyProperty

IsTopBottomViewReverseOrientedProperty

Identifies the IsTopBottomViewReverseOriented dependency property.

public static readonly DependencyProperty IsTopBottomViewReverseOrientedProperty

Field Value

DependencyProperty

IsTouchZoomEnabledProperty

Identifies the IsTouchZoomEnabled dependency property.

public static readonly DependencyProperty IsTouchZoomEnabledProperty

Field Value

DependencyProperty

IsViewCubeEdgeClicksEnabledProperty

Identifies the IsViewCubeEdgeClicksEnabled dependency property.

public static readonly DependencyProperty IsViewCubeEdgeClicksEnabledProperty

Field Value

DependencyProperty

IsZoomEnabledProperty

Identifies the IsZoomEnabled dependency property.

public static readonly DependencyProperty IsZoomEnabledProperty

Field Value

DependencyProperty

LeftRightPanSensitivityProperty

Identifies the LeftRightPanSensitivity dependency property.

public static readonly DependencyProperty LeftRightPanSensitivityProperty

Field Value

DependencyProperty

LeftRightRotationSensitivityProperty

Identifies the LeftRightRotationSensitivity dependency property.

public static readonly DependencyProperty LeftRightRotationSensitivityProperty

Field Value

DependencyProperty

LeftViewGestureProperty

Identifies the LeftViewGesture dependency property.

public static readonly DependencyProperty LeftViewGestureProperty

Field Value

DependencyProperty

LimitFPSProperty

The limit FPS property

public static readonly DependencyProperty LimitFPSProperty

Field Value

DependencyProperty

LookAtChangedEvent

The look at (target) point changed event

public static readonly RoutedEvent LookAtChangedEvent

Field Value

RoutedEvent

MaximumFieldOfViewProperty

Identifies the MaximumFieldOfView dependency property.

public static readonly DependencyProperty MaximumFieldOfViewProperty

Field Value

DependencyProperty

MinimumFieldOfViewProperty

Identifies the MinimumFieldOfView dependency property.

public static readonly DependencyProperty MinimumFieldOfViewProperty

Field Value

DependencyProperty

ModelUpDirectionProperty

Identifies the ModelUpDirection dependency property.

public static readonly DependencyProperty ModelUpDirectionProperty

Field Value

DependencyProperty

OrthographicProperty

Identifies the Orthographic dependency property.

public static readonly DependencyProperty OrthographicProperty

Field Value

DependencyProperty

OrthographicToggleGestureProperty

Identifies the OrthographicToggleGesture dependency property.

public static readonly DependencyProperty OrthographicToggleGestureProperty

Field Value

DependencyProperty

PageUpDownZoomSensitivityProperty

Identifies the PageUpDownZoomSensitivity dependency property.

public static readonly DependencyProperty PageUpDownZoomSensitivityProperty

Field Value

DependencyProperty

PanCursorProperty

Identifies the PanCursor dependency property.

public static readonly DependencyProperty PanCursorProperty

Field Value

DependencyProperty

PanGesture2Property

Identifies the PanGesture2 dependency property.

public static readonly DependencyProperty PanGesture2Property

Field Value

DependencyProperty

PanGestureProperty

Identifies the PanGesture dependency property.

public static readonly DependencyProperty PanGestureProperty

Field Value

DependencyProperty

ResetCameraGestureProperty

Identifies the ResetCameraGesture dependency property.

public static readonly DependencyProperty ResetCameraGestureProperty

Field Value

DependencyProperty

ResetCameraKeyGestureProperty

Identifies the ResetCameraKeyGesture dependency property.

public static readonly DependencyProperty ResetCameraKeyGestureProperty

Field Value

DependencyProperty

RightViewGestureProperty

Identifies the RightViewGesture dependency property.

public static readonly DependencyProperty RightViewGestureProperty

Field Value

DependencyProperty

RotateAroundMouseDownPointProperty

Identifies the RotateAroundMouseDownPoint dependency property.

public static readonly DependencyProperty RotateAroundMouseDownPointProperty

Field Value

DependencyProperty

RotateCursorProperty

Identifies the RotateCursor dependency property.

public static readonly DependencyProperty RotateCursorProperty

Field Value

DependencyProperty

RotateGesture2Property

Identifies the RotateGesture2 dependency property.

public static readonly DependencyProperty RotateGesture2Property

Field Value

DependencyProperty

RotateGestureProperty

Identifies the RotateGesture dependency property.

public static readonly DependencyProperty RotateGestureProperty

Field Value

DependencyProperty

RotationSensitivityProperty

Identifies the RotationSensitivity dependency property.

public static readonly DependencyProperty RotationSensitivityProperty

Field Value

DependencyProperty

ShowCameraInfoProperty

Identifies the ShowCameraInfo dependency property.

public static readonly DependencyProperty ShowCameraInfoProperty

Field Value

DependencyProperty

ShowCameraTargetProperty

Identifies the ShowCameraTarget dependency property.

public static readonly DependencyProperty ShowCameraTargetProperty

Field Value

DependencyProperty

ShowCoordinateSystemProperty

Identifies the ShowCoordinateSystem dependency property.

public static readonly DependencyProperty ShowCoordinateSystemProperty

Field Value

DependencyProperty

ShowFieldOfViewProperty

Identifies the ShowFieldOfView dependency property.

public static readonly DependencyProperty ShowFieldOfViewProperty

Field Value

DependencyProperty

ShowFrameRateProperty

Identifies the ShowFrameRate dependency property.

public static readonly DependencyProperty ShowFrameRateProperty

Field Value

DependencyProperty

ShowTriangleCountInfoProperty

Identifies the ShowTriangleCountInfo dependency property.

public static readonly DependencyProperty ShowTriangleCountInfoProperty

Field Value

DependencyProperty

ShowViewCubeProperty

Identifies the ShowViewCube dependency property.

public static readonly DependencyProperty ShowViewCubeProperty

Field Value

DependencyProperty

SnapMouseDownPointProperty

Identifies the SnapMouseDownPoint dependency property.

public static readonly DependencyProperty SnapMouseDownPointProperty

Field Value

DependencyProperty

StatusProperty

Identifies the Status dependency property.

public static readonly DependencyProperty StatusProperty

Field Value

DependencyProperty

SubTitleProperty

Identifies the SubTitle dependency property.

public static readonly DependencyProperty SubTitleProperty

Field Value

DependencyProperty

SubTitleSizeProperty

Identifies the SubTitleSize dependency property.

public static readonly DependencyProperty SubTitleSizeProperty

Field Value

DependencyProperty

TextBrushProperty

Identifies the TextBrush dependency property.

public static readonly DependencyProperty TextBrushProperty

Field Value

DependencyProperty

TitleBackgroundProperty

Identifies the TitleBackground dependency property.

public static readonly DependencyProperty TitleBackgroundProperty

Field Value

DependencyProperty

TitleFontFamilyProperty

Identifies the TitleFontFamily dependency property.

public static readonly DependencyProperty TitleFontFamilyProperty

Field Value

DependencyProperty

TitleProperty

Identifies the Title dependency property.

public static readonly DependencyProperty TitleProperty

Field Value

DependencyProperty

TitleSizeProperty

Identifies the TitleSize dependency property.

public static readonly DependencyProperty TitleSizeProperty

Field Value

DependencyProperty

TopViewGestureProperty

Identifies the TopViewGesture dependency property.

public static readonly DependencyProperty TopViewGestureProperty

Field Value

DependencyProperty

TriangleCountInfoProperty

Identifies the TriangleCountInfo dependency property.

public static readonly DependencyProperty TriangleCountInfoProperty

Field Value

DependencyProperty

UpDownPanSensitivityProperty

Identifies the UpDownPanSensitivity dependency property.

public static readonly DependencyProperty UpDownPanSensitivityProperty

Field Value

DependencyProperty

UpDownRotationSensitivityProperty

Identifies the UpDownRotationSensitivity dependency property.

public static readonly DependencyProperty UpDownRotationSensitivityProperty

Field Value

DependencyProperty

ViewCubeBackTextProperty

Identifies the ViewCubeBackText dependency property.

public static readonly DependencyProperty ViewCubeBackTextProperty

Field Value

DependencyProperty

ViewCubeBottomTextProperty

Identifies the ViewCubeBottomText dependency property.

public static readonly DependencyProperty ViewCubeBottomTextProperty

Field Value

DependencyProperty

ViewCubeFrontTextProperty

Identifies the ViewCubeFrontText dependency property.

public static readonly DependencyProperty ViewCubeFrontTextProperty

Field Value

DependencyProperty

ViewCubeHeightProperty

Identifies the ViewCubeHeight dependency property.

public static readonly DependencyProperty ViewCubeHeightProperty

Field Value

DependencyProperty

ViewCubeHorizontalPositionProperty

Identifies the ViewCubeHorizontalPosition dependency property.

public static readonly DependencyProperty ViewCubeHorizontalPositionProperty

Field Value

DependencyProperty

ViewCubeLeftTextProperty

Identifies the ViewCubeLeftText dependency property.

public static readonly DependencyProperty ViewCubeLeftTextProperty

Field Value

DependencyProperty

ViewCubeOpacityProperty

Identifies the ViewCubeOpacity dependency property.

public static readonly DependencyProperty ViewCubeOpacityProperty

Field Value

DependencyProperty

ViewCubeRightTextProperty

Identifies the ViewCubeRightText dependency property.

public static readonly DependencyProperty ViewCubeRightTextProperty

Field Value

DependencyProperty

ViewCubeTopTextProperty

Identifies the ViewCubeTopText dependency property.

public static readonly DependencyProperty ViewCubeTopTextProperty

Field Value

DependencyProperty

ViewCubeVerticalPositionProperty

Identifies the ViewCubeVerticalPosition dependency property.

public static readonly DependencyProperty ViewCubeVerticalPositionProperty

Field Value

DependencyProperty

ViewCubeWidthProperty

Identifies the ViewCubeWidth dependency property.

public static readonly DependencyProperty ViewCubeWidthProperty

Field Value

DependencyProperty

ZoomAroundMouseDownPointProperty

Identifies the ZoomAroundMouseDownPoint dependency property.

public static readonly DependencyProperty ZoomAroundMouseDownPointProperty

Field Value

DependencyProperty

ZoomCursorProperty

Identifies the ZoomCursor dependency property.

public static readonly DependencyProperty ZoomCursorProperty

Field Value

DependencyProperty

ZoomExtentsGestureProperty

Identifies the ZoomExtentsGesture dependency property.

public static readonly DependencyProperty ZoomExtentsGestureProperty

Field Value

DependencyProperty

ZoomExtentsWhenLoadedProperty

Identifies the ZoomExtentsWhenLoaded dependency property.

public static readonly DependencyProperty ZoomExtentsWhenLoadedProperty

Field Value

DependencyProperty

ZoomGesture2Property

Identifies the ZoomGesture2 dependency property.

public static readonly DependencyProperty ZoomGesture2Property

Field Value

DependencyProperty

ZoomGestureProperty

Identifies the ZoomGesture dependency property.

public static readonly DependencyProperty ZoomGestureProperty

Field Value

DependencyProperty

ZoomRectangleCursorProperty

Identifies the ZoomRectangleCursor dependency property.

public static readonly DependencyProperty ZoomRectangleCursorProperty

Field Value

DependencyProperty

ZoomRectangleGestureProperty

Identifies the ZoomRectangleGesture dependency property.

public static readonly DependencyProperty ZoomRectangleGestureProperty

Field Value

DependencyProperty

ZoomSensitivityProperty

Identifies the ZoomSensitivity dependency property.

public static readonly DependencyProperty ZoomSensitivityProperty

Field Value

DependencyProperty

ZoomedByRectangleEvent

Identifies the ZoomedByRectangle routed event.

public static readonly RoutedEvent ZoomedByRectangleEvent

Field Value

RoutedEvent

Properties

BackViewGesture

Gets or sets the back view gesture.

public InputGesture BackViewGesture { get; set; }

Property Value

InputGesture

The back view gesture.

BottomViewGesture

Gets or sets the bottom view gesture.

public InputGesture BottomViewGesture { get; set; }

Property Value

InputGesture

The bottom view gesture.

Camera

Gets or sets the camera.

public ProjectionCamera? Camera { get; set; }

Property Value

ProjectionCamera

The camera.

CameraController

Gets the camera controller.

public CameraController? CameraController { get; }

Property Value

CameraController

CameraInertiaFactor

Gets or sets the camera inertia factor.

public double CameraInertiaFactor { get; set; }

Property Value

double

The camera inertia factor.

CameraInfo

Gets the camera info.

public string CameraInfo { get; }

Property Value

string

The camera info.

CameraMode

Gets or sets the CameraMode

public CameraMode CameraMode { get; set; }

Property Value

CameraMode

CameraRotationMode

Gets or sets the camera rotation mode.

public CameraRotationMode CameraRotationMode { get; set; }

Property Value

CameraRotationMode

ChangeFieldOfViewCursor

Gets or sets the cursor used when changing field of view.

public Cursor ChangeFieldOfViewCursor { get; set; }

Property Value

Cursor

A Cursor.

ChangeFieldOfViewGesture

Gets or sets the change field of view gesture.

public MouseGesture ChangeFieldOfViewGesture { get; set; }

Property Value

MouseGesture

The change field of view gesture.

ChangeLookAtGesture

Gets or sets the change look-at gesture.

public MouseGesture ChangeLookAtGesture { get; set; }

Property Value

MouseGesture

The change look-at gesture.

Children

Gets the children.

public Visual3DCollection Children { get; }

Property Value

Visual3DCollection

The children.

ConstructionPlane

Gets or sets the plane that defines the CursorOnConstructionPlanePosition.

public Plane3D ConstructionPlane { get; set; }

Property Value

Plane3D

The plane used to calculate the CursorOnConstructionPlanePosition.

CoordinateSystemHeight

Gets or sets the height of the coordinate system viewport.

public double CoordinateSystemHeight { get; set; }

Property Value

double

The height of the coordinate system viewport.

CoordinateSystemHorizontalPosition

Gets or sets the horizontal position of the coordinate system viewport.

public HorizontalAlignment CoordinateSystemHorizontalPosition { get; set; }

Property Value

HorizontalAlignment

The horizontal position.

CoordinateSystemLabelForeground

Gets or sets the color of the coordinate system label.

public Brush CoordinateSystemLabelForeground { get; set; }

Property Value

Brush

The color of the coordinate system label.

CoordinateSystemLabelX

Gets or sets the coordinate system X label.

public string CoordinateSystemLabelX { get; set; }

Property Value

string

The coordinate system X label.

CoordinateSystemLabelY

Gets or sets the coordinate system Y label.

public string CoordinateSystemLabelY { get; set; }

Property Value

string

The coordinate system Y label.

CoordinateSystemLabelZ

Gets or sets the coordinate system Z label.

public string CoordinateSystemLabelZ { get; set; }

Property Value

string

The coordinate system Z label.

CoordinateSystemVerticalPosition

Gets or sets the vertical position of the coordinate system viewport.

public VerticalAlignment CoordinateSystemVerticalPosition { get; set; }

Property Value

VerticalAlignment

The vertical position.

CoordinateSystemWidth

Gets or sets the width of the coordinate system viewport.

public double CoordinateSystemWidth { get; set; }

Property Value

double

The width of the coordinate system viewport.

CursorOnConstructionPlanePosition

Gets the current cursor position on the cursor plane.

public Point3D? CursorOnConstructionPlanePosition { get; }

Property Value

Point3D?

The cursor plane position.

Remarks

The EnableCursorPosition property must be set to true to enable updating of this property.

CursorOnElementPosition

Gets the current cursor position on the nearest model. If the model is not hit, the position is null.

public Point3D? CursorOnElementPosition { get; }

Property Value

Point3D?

The position of the model intersection.

Remarks

The EnableCursorPosition property must be set to true to enable updating of this property.

CursorPosition

Gets the current cursor position.

public Point3D? CursorPosition { get; }

Property Value

Point3D?

The current cursor position.

Remarks

The EnableCursorPosition property must be set to true to enable updating of this property.

CursorRay

Gets the cursor ray.

public Ray3D? CursorRay { get; }

Property Value

Ray3D

The cursor ray.

DebugInfo

Gets or sets the debug info text.

public string DebugInfo { get; set; }

Property Value

string

The debug info text.

DefaultCamera

Gets or sets the default camera.

public ProjectionCamera DefaultCamera { get; set; }

Property Value

ProjectionCamera

The default camera.

EnableCursorPosition

Gets or sets a value indicating whether calculation of the CursorPosition properties is enabled.

public bool EnableCursorPosition { get; set; }

Property Value

bool

true if calculation is enabled; otherwise, false .

FieldOfViewText

Gets the field of view text.

public string FieldOfViewText { get; }

Property Value

string

The field of view text.

FixedRotationPoint

Gets or sets a value indicating the center of rotation.

public Point3D FixedRotationPoint { get; set; }

Property Value

Point3D

true if rotation around a fixed point is enabled; otherwise, false .

FixedRotationPointEnabled

Gets or sets a value indicating whether to rotate around a fixed point.

public bool FixedRotationPointEnabled { get; set; }

Property Value

bool

true if rotation around a fixed point is enabled; otherwise, false .

FrameRate

Gets the frame rate.

public int FrameRate { get; }

Property Value

int

The frame rate.

FrameRateText

Gets the frame rate text.

public string FrameRateText { get; }

Property Value

string

The frame rate text.

FrontViewGesture

Gets or sets the front view gesture.

public InputGesture FrontViewGesture { get; set; }

Property Value

InputGesture

The front view gesture.

InfiniteSpin

Gets or sets a value indicating whether to enable infinite spin.

public bool InfiniteSpin { get; set; }

Property Value

bool

true if infinite spin is enabled; otherwise, false .

InfoBackground

Gets or sets the background brush for the CameraInfo and TriangleCount fields.

public Brush InfoBackground { get; set; }

Property Value

Brush

The info background.

InfoForeground

Gets or sets the foreground brush for informational text.

public Brush InfoForeground { get; set; }

Property Value

Brush

The foreground brush.

IsChangeFieldOfViewEnabled

Gets or sets a value indicating whether change of field-of-view is enabled.

public bool IsChangeFieldOfViewEnabled { get; set; }

Property Value

bool

IsHeadLightEnabled

Gets or sets a value indicating whether the head light is enabled.

public bool IsHeadLightEnabled { get; set; }

Property Value

bool

true if the head light is enabled; otherwise, false .

IsInertiaEnabled

Gets or sets a value indicating whether inertia is enabled for the camera manipulations.

public bool IsInertiaEnabled { get; set; }

Property Value

bool

true if inertia is enabled; otherwise, false.

IsMoveEnabled

Gets or sets a value indicating whether move (by AWSD keys) is enabled.

public bool IsMoveEnabled { get; set; }

Property Value

bool

IsPanEnabled

Gets or sets a value indicating whether pan is enabled.

public bool IsPanEnabled { get; set; }

Property Value

bool

IsRotationEnabled

Gets or sets a value indicating whether rotation is enabled.

public bool IsRotationEnabled { get; set; }

Property Value

bool

IsTopBottomViewOrientedToFrontBack

Gets or sets a value indicating whether the top and bottom views are oriented to front and back.

public bool IsTopBottomViewOrientedToFrontBack { get; set; }

Property Value

bool

IsTopBottomViewReverseOriented

Gets or sets a value indicating whether the top and bottom views reverse oriented.

public bool IsTopBottomViewReverseOriented { get; set; }

Property Value

bool

IsTouchZoomEnabled

Gets or sets a value indicating whether touch zoom (pinch gesture) is enabled.

public bool IsTouchZoomEnabled { get; set; }

Property Value

bool

true if touch zoom is enabled; otherwise, false .

IsViewCubeEdgeClicksEnabled

Gets or sets the view cube edge clickable.

public bool IsViewCubeEdgeClicksEnabled { get; set; }

Property Value

bool

IsZoomEnabled

Gets or sets a value indicating whether zoom is enabled.

public bool IsZoomEnabled { get; set; }

Property Value

bool

LeftRightPanSensitivity

Gets or sets the sensitivity for pan by the left and right keys.

public double LeftRightPanSensitivity { get; set; }

Property Value

double

The pan sensitivity.

Remarks

Use -1 to invert the pan direction.

LeftRightRotationSensitivity

Gets or sets the sensitivity for rotation by the left and right keys.

public double LeftRightRotationSensitivity { get; set; }

Property Value

double

The rotation sensitivity.

Remarks

Use -1 to invert the rotation direction.

LeftViewGesture

Gets or sets the left view gesture.

public InputGesture LeftViewGesture { get; set; }

Property Value

InputGesture

The left view gesture.

Lights

Gets the lights.

public Model3DGroup Lights { get; }

Property Value

Model3DGroup

The lights.

LimitFPS

Gets or sets a value indicating whether [limit FPS].

public bool LimitFPS { get; set; }

Property Value

bool

true if [limit FPS]; otherwise, false.

MaximumFieldOfView

Gets or sets the maximum field of view.

public double MaximumFieldOfView { get; set; }

Property Value

double

The maximum field of view.

MinimumFieldOfView

Gets or sets the minimum field of view.

public double MinimumFieldOfView { get; set; }

Property Value

double

The minimum field of view.

ModelUpDirection

Gets or sets the up direction of the model. This is used by the view cube.

public Vector3D ModelUpDirection { get; set; }

Property Value

Vector3D

The model up direction.

Orthographic

Gets or sets a value indicating whether this HelixViewport3D should use an orthographic camera.

public bool Orthographic { get; set; }

Property Value

bool

true if an orthographic camera should be used; otherwise, false .

OrthographicToggleCommand

Gets the command that toggles between orthographic and perspective camera.

public static RoutedCommand OrthographicToggleCommand { get; }

Property Value

RoutedCommand

OrthographicToggleGesture

Gets or sets the orthographic toggle gesture.

public InputGesture OrthographicToggleGesture { get; set; }

Property Value

InputGesture

The orthographic toggle gesture.

PageUpDownZoomSensitivity

Gets or sets the sensitivity for zoom by the page up and page down keys.

public double PageUpDownZoomSensitivity { get; set; }

Property Value

double

The zoom sensitivity.

Remarks

Use -1 to invert the zoom direction.

PanCursor

Gets or sets the pan cursor.

public Cursor PanCursor { get; set; }

Property Value

Cursor

The pan cursor.

PanGesture

Gets or sets the pan gesture.

public MouseGesture PanGesture { get; set; }

Property Value

MouseGesture

The pan gesture.

PanGesture2

Gets or sets the alternative pan gesture.

public MouseGesture PanGesture2 { get; set; }

Property Value

MouseGesture

The alternative pan gesture.

ResetCameraGesture

Gets or sets the reset camera gesture.

public InputGesture ResetCameraGesture { get; set; }

Property Value

InputGesture

ResetCameraKeyGesture

Gets or sets the reset camera key gesture.

public KeyGesture ResetCameraKeyGesture { get; set; }

Property Value

KeyGesture

The reset camera key gesture.

RightViewGesture

Gets or sets the right view gesture.

public InputGesture RightViewGesture { get; set; }

Property Value

InputGesture

The right view gesture.

RotateAroundMouseDownPoint

Gets or sets a value indicating whether to rotate around the mouse down point.

public bool RotateAroundMouseDownPoint { get; set; }

Property Value

bool

true if rotation around the mouse down point is enabled; otherwise, false .

RotateCursor

Gets or sets the rotation cursor.

public Cursor RotateCursor { get; set; }

Property Value

Cursor

The rotation cursor.

RotateGesture

Gets or sets the rotation gesture.

public MouseGesture RotateGesture { get; set; }

Property Value

MouseGesture

The rotation gesture.

RotateGesture2

Gets or sets the alternative rotation gesture.

public MouseGesture RotateGesture2 { get; set; }

Property Value

MouseGesture

The alternative rotation gesture.

RotationSensitivity

Gets or sets the rotation sensitivity.

public double RotationSensitivity { get; set; }

Property Value

double

The rotation sensitivity.

ShowCameraInfo

Gets or sets a value indicating whether to show camera info.

public bool ShowCameraInfo { get; set; }

Property Value

bool

true if the camera info should be shown; otherwise, false .

ShowCameraTarget

Gets or sets a value indicating whether to show the camera target adorner.

public bool ShowCameraTarget { get; set; }

Property Value

bool

true if the camera target adorner should be shown; otherwise, false .

ShowCoordinateSystem

Gets or sets a value indicating whether to show the coordinate system.

public bool ShowCoordinateSystem { get; set; }

Property Value

bool

true if the coordinate system should be shown; otherwise, false .

ShowFieldOfView

Gets or sets a value indicating whether to show the current field of view.

public bool ShowFieldOfView { get; set; }

Property Value

bool

true if field of view should be shown; otherwise, false .

ShowFrameRate

Gets or sets a value indicating whether to show the frame rate.

public bool ShowFrameRate { get; set; }

Property Value

bool

true if the frame rate should be shown; otherwise, false .

ShowTriangleCountInfo

Gets or sets a value indicating whether to show the total number of triangles in the scene.

public bool ShowTriangleCountInfo { get; set; }

Property Value

bool

ShowViewCube

Gets or sets a value indicating whether to show the view cube.

public bool ShowViewCube { get; set; }

Property Value

bool

true if the view cube should be shown; otherwise, false .

SnapMouseDownPoint

Gets or sets a value indicating whether to snap the mouse down point to a model.

public bool SnapMouseDownPoint { get; set; }

Property Value

bool

true if snapping the mouse down point is enabled; otherwise, false .

Status

Gets or sets the status.

public string Status { get; set; }

Property Value

string

The status.

SubTitle

Gets or sets the sub title.

public string SubTitle { get; set; }

Property Value

string

The sub title.

SubTitleSize

Gets or sets the size of the sub title.

public double SubTitleSize { get; set; }

Property Value

double

The size of the sub title.

TextBrush

Gets or sets the text brush.

public Brush TextBrush { get; set; }

Property Value

Brush

The text brush.

Title

Gets or sets the title.

public string Title { get; set; }

Property Value

string

The title.

TitleBackground

Gets or sets the title background brush.

public Brush TitleBackground { get; set; }

Property Value

Brush

The title background.

TitleFontFamily

Gets or sets the title font family.

public FontFamily TitleFontFamily { get; set; }

Property Value

FontFamily

The title font family.

TitleSize

Gets or sets the size of the title.

public double TitleSize { get; set; }

Property Value

double

The size of the title.

TopViewGesture

Gets or sets the top view gesture.

public InputGesture TopViewGesture { get; set; }

Property Value

InputGesture

The top view gesture.

TriangleCountInfo

Gets information about the triangle count.

public string TriangleCountInfo { get; }

Property Value

string

UpDownPanSensitivity

Gets or sets the sensitivity for pan by the up and down keys.

public double UpDownPanSensitivity { get; set; }

Property Value

double

The pan sensitivity.

Remarks

Use -1 to invert the pan direction.

UpDownRotationSensitivity

Gets or sets the sensitivity for rotation by the up and down keys.

public double UpDownRotationSensitivity { get; set; }

Property Value

double

The rotation sensitivity.

Remarks

Use -1 to invert the rotation direction.

ViewCubeBackText

Gets or sets the view cube back text.

public string ViewCubeBackText { get; set; }

Property Value

string

The view cube back text.

ViewCubeBottomText

Gets or sets the view cube bottom text.

public string ViewCubeBottomText { get; set; }

Property Value

string

The view cube bottom text.

ViewCubeFrontText

Gets or sets the view cube front text.

public string ViewCubeFrontText { get; set; }

Property Value

string

The view cube front text.

ViewCubeHeight

Gets or sets the height of the view cube viewport.

public double ViewCubeHeight { get; set; }

Property Value

double

The height of the view cube viewport.

ViewCubeHorizontalPosition

Gets or sets the horizontal position of the view cube viewport.

public HorizontalAlignment ViewCubeHorizontalPosition { get; set; }

Property Value

HorizontalAlignment

The horizontal position.

ViewCubeLeftText

Gets or sets the view cube left text.

public string ViewCubeLeftText { get; set; }

Property Value

string

The view cube left text.

ViewCubeOpacity

Gets or sets the opacity of the view cube when inactive.

public double ViewCubeOpacity { get; set; }

Property Value

double

ViewCubeRightText

Gets or sets the view cube right text.

public string ViewCubeRightText { get; set; }

Property Value

string

The view cube right text.

ViewCubeTopText

Gets or sets the view cube top text.

public string ViewCubeTopText { get; set; }

Property Value

string

The view cube top text.

ViewCubeVerticalPosition

Gets or sets the vertical position of view cube viewport.

public VerticalAlignment ViewCubeVerticalPosition { get; set; }

Property Value

VerticalAlignment

The vertical position.

ViewCubeWidth

Gets or sets the width of the view cube viewport.

public double ViewCubeWidth { get; set; }

Property Value

double

The width of the view cube viewport.

Viewport

Gets the viewport.

public Viewport3D Viewport { get; }

Property Value

Viewport3D

The viewport.

ZoomAroundMouseDownPoint

Gets or sets a value indicating whether to zoom around the mouse down point.

public bool ZoomAroundMouseDownPoint { get; set; }

Property Value

bool

true if zooming around the mouse down point is enabled; otherwise, false .

ZoomCursor

Gets or sets the zoom cursor.

public Cursor ZoomCursor { get; set; }

Property Value

Cursor

The zoom cursor.

ZoomExtentsGesture

Gets or sets the zoom extents gesture.

public InputGesture ZoomExtentsGesture { get; set; }

Property Value

InputGesture

ZoomExtentsWhenLoaded

Gets or sets a value indicating whether to Zoom extents when the control has loaded.

public bool ZoomExtentsWhenLoaded { get; set; }

Property Value

bool

ZoomGesture

Gets or sets the zoom gesture.

public MouseGesture ZoomGesture { get; set; }

Property Value

MouseGesture

The zoom gesture.

ZoomGesture2

Gets or sets the alternative zoom gesture.

public MouseGesture ZoomGesture2 { get; set; }

Property Value

MouseGesture

The alternative zoom gesture.

ZoomRectangleCursor

Gets or sets the zoom rectangle cursor.

public Cursor ZoomRectangleCursor { get; set; }

Property Value

Cursor

The zoom rectangle cursor.

ZoomRectangleGesture

Gets or sets the zoom rectangle gesture.

public MouseGesture ZoomRectangleGesture { get; set; }

Property Value

MouseGesture

The zoom rectangle gesture.

ZoomSensitivity

Gets or sets the zoom sensitivity.

public double ZoomSensitivity { get; set; }

Property Value

double

The zoom sensitivity.

Methods

ChangeCameraDirection(Vector3D, double)

Changes the camera direction.

public void ChangeCameraDirection(Vector3D newDirection, double animationTime = 0)

Parameters

newDirection Vector3D

The new direction.

animationTime double

The animation time.

Copy()

Copies the view to the clipboard.

public void Copy()

CopyXaml()

Copies the view to the clipboard as xaml.

public void CopyXaml()

Export(string)

Exports the view to the specified file.

public void Export(string fileName)

Parameters

fileName string

Name of the file.

Remarks

Exporters.Filter contains all supported export file types.

ExportStereo(string, double)

Exports the view to a stereo image with the specified file name.

public void ExportStereo(string fileName, double stereoBase)

Parameters

fileName string

Name of the file.

stereoBase double

The stereo base.

FindNearest(Point, out Point3D, out Vector3D, out DependencyObject?)

Finds the nearest object.

public bool FindNearest(Point pt, out Point3D pos, out Vector3D normal, out DependencyObject? obj)

Parameters

pt Point

The 3D position.

pos Point3D

The 2D position.

normal Vector3D

The normal at the hit point.

obj DependencyObject

The object that was hit.

Returns

bool

True if an object was hit.

FindNearestPoint(Point)

Finds the nearest point.

public Point3D? FindNearestPoint(Point pt)

Parameters

pt Point

The point.

Returns

Point3D?

A point.

FindNearestVisual(Point)

Finds the Visual3D that is nearest the camera ray through the specified point.

public Visual3D? FindNearestVisual(Point pt)

Parameters

pt Point

The point.

Returns

Visual3D

The nearest Visual3D or null if no visual was hit.

FitView(Vector3D, Vector3D, double)

Sets the camera orientation and adjusts the camera position to fit the model into the view.

public void FitView(Vector3D newDirection, Vector3D newUpDirection, double animationTime = 0)

Parameters

newDirection Vector3D

The new camera look direction.

newUpDirection Vector3D

The new camera up direction.

animationTime double

The animation time.

LookAt(Point3D, double)

Changes the camera to look at the specified point.

public void LookAt(Point3D target, double animationTime = 0)

Parameters

target Point3D

The point.

animationTime double

The animation time.

LookAt(Point3D, double, double)

Changes the camera to look at the specified point.

public void LookAt(Point3D target, double distance, double animationTime)

Parameters

target Point3D

The target point.

distance double

The distance.

animationTime double

The animation time.

LookAt(Point3D, Vector3D, double)

Changes the camera to look at the specified point.

public void LookAt(Point3D target, Vector3D direction, double animationTime)

Parameters

target Point3D

The target point.

direction Vector3D

The direction.

animationTime double

The animation time.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate() .

public override void OnApplyTemplate()

Exceptions

HelixToolkitException

A part is missing from the template.

OnCameraChanged()

Handles camera changes.

protected virtual void OnCameraChanged()

OnHeadlightChanged()

Handles changes to the IsHeadLightEnabled property.

protected void OnHeadlightChanged()

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the Items property changes.

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

e NotifyCollectionChangedEventArgs

Information about the change.

Exceptions

NotImplementedException

Move operation not implemented. or Replace operation not implemented.

OnItemsSourceChanged(IEnumerable, IEnumerable)

Called when the ItemsSource property changes.

protected override void OnItemsSourceChanged(IEnumerable oldValue, IEnumerable newValue)

Parameters

oldValue IEnumerable

Old value of the ItemsSource property.

newValue IEnumerable

New value of the ItemsSource property.

OnLookAtChanged()

Raises the LookAtChanged event.

protected virtual void OnLookAtChanged()

OnMouseMove(MouseEventArgs)

Invoked when an unhandled MouseMove attached event reaches an element in its route that is derived from this class.

protected override void OnMouseMove(MouseEventArgs e)

Parameters

e MouseEventArgs

The MouseEventArgs that contains the event data.

OnZoomedByRectangle()

Raises the ZoomedByRectangle event.

protected virtual void OnZoomedByRectangle()

RaiseCameraChangedEvent()

Raises the camera changed event.

protected virtual void RaiseCameraChangedEvent()

ResetCamera()

Resets the camera.

public void ResetCamera()

SetView(Point3D, Vector3D, Vector3D, double)

Sets the camera position and orientation.

public void SetView(Point3D newPosition, Vector3D newDirection, Vector3D newUpDirection, double animationTime = 0)

Parameters

newPosition Point3D

The new camera position.

newDirection Vector3D

The new camera look direction.

newUpDirection Vector3D

The new camera up direction.

animationTime double

The animation time.

ZoomExtents(double)

Zooms to the extents of the screen.

public void ZoomExtents(double animationTime = 0)

Parameters

animationTime double

The animation time.

ZoomExtents(Rect3D, double)

Zooms to the extents of the specified bounding box.

public void ZoomExtents(Rect3D bounds, double animationTime = 0)

Parameters

bounds Rect3D

The bounding box.

animationTime double

The animation time.

Events

CameraChanged

Event when a property has been changed

public event RoutedEventHandler CameraChanged

Event Type

RoutedEventHandler

LookAtChanged

Occurs when the look at/target point changed.

public event RoutedEventHandler LookAtChanged

Event Type

RoutedEventHandler

ZoomedByRectangle

Occurs when the view is zoomed by rectangle.

public event RoutedEventHandler ZoomedByRectangle

Event Type

RoutedEventHandler
Edit this page