Table of Contents

Class Viewport3DX

Namespace
HelixToolkit.Avalonia.SharpDX
Assembly
HelixToolkit.Avalonia.SharpDX.dll

Provides a Viewport control.

public class Viewport3DX : TemplatedControl, INotifyPropertyChanged, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, ISupportInitialize, IStyleable, INamed, IInputElement, IDataTemplateHost, ISetterValue, IViewport3DX, IDisposable
Inheritance
AvaloniaObject
Animatable
StyledElement
Visual
Layoutable
Interactive
InputElement
Control
TemplatedControl
Viewport3DX
Implements
IDataContextProvider
ILogical
IThemeVariantHost
IResourceHost
IResourceNode
IStyleHost
ISetLogicalParent
ISetInheritanceParent
IStyleable
INamed
IInputElement
IDataTemplateHost
ISetterValue
Inherited Members
TemplatedControl.BackgroundProperty
TemplatedControl.BackgroundSizingProperty
TemplatedControl.BorderBrushProperty
TemplatedControl.BorderThicknessProperty
TemplatedControl.CornerRadiusProperty
TemplatedControl.FontFamilyProperty
TemplatedControl.FontFeaturesProperty
TemplatedControl.FontSizeProperty
TemplatedControl.FontStyleProperty
TemplatedControl.FontWeightProperty
TemplatedControl.FontStretchProperty
TemplatedControl.ForegroundProperty
TemplatedControl.PaddingProperty
TemplatedControl.TemplateProperty
TemplatedControl.IsTemplateFocusTargetProperty
TemplatedControl.TemplateAppliedEvent
TemplatedControl.GetIsTemplateFocusTarget(Control)
TemplatedControl.ApplyTemplate()
TemplatedControl.GetTemplateFocusTarget()
TemplatedControl.OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs)
TemplatedControl.OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs)
TemplatedControl.OnTemplateChanged(AvaloniaPropertyChangedEventArgs)
TemplatedControl.Background
TemplatedControl.BackgroundSizing
TemplatedControl.BorderBrush
TemplatedControl.BorderThickness
TemplatedControl.CornerRadius
TemplatedControl.FontFamily
TemplatedControl.FontFeatures
TemplatedControl.FontSize
TemplatedControl.FontStyle
TemplatedControl.FontWeight
TemplatedControl.FontStretch
TemplatedControl.Foreground
TemplatedControl.Padding
TemplatedControl.Template
TemplatedControl.TemplateApplied
Control.FocusAdornerProperty
Control.TagProperty
Control.ContextMenuProperty
Control.ContextFlyoutProperty
Control.RequestBringIntoViewEvent
Control.ContextRequestedEvent
Control.LoadedEvent
Control.UnloadedEvent
Control.SizeChangedEvent
Control.OnLoaded(RoutedEventArgs)
Control.OnUnloaded(RoutedEventArgs)
Control.OnSizeChanged(SizeChangedEventArgs)
Control.OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs)
Control.OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)
Control.OnGotFocus(GotFocusEventArgs)
Control.OnLostFocus(RoutedEventArgs)
Control.OnCreateAutomationPeer()
Control.OnKeyUp(KeyEventArgs)
Control.OnPropertyChanged(AvaloniaPropertyChangedEventArgs)
Control.FocusAdorner
Control.DataTemplates
Control.ContextMenu
Control.ContextFlyout
Control.IsLoaded
Control.Tag
Control.ContextRequested
Control.Loaded
Control.Unloaded
Control.SizeChanged
InputElement.FocusableProperty
InputElement.IsEnabledProperty
InputElement.IsEffectivelyEnabledProperty
InputElement.CursorProperty
InputElement.IsKeyboardFocusWithinProperty
InputElement.IsFocusedProperty
InputElement.IsHitTestVisibleProperty
InputElement.IsPointerOverProperty
InputElement.IsTabStopProperty
InputElement.GotFocusEvent
InputElement.LostFocusEvent
InputElement.KeyDownEvent
InputElement.KeyUpEvent
InputElement.TabIndexProperty
InputElement.TextInputEvent
InputElement.TextInputMethodClientRequestedEvent
InputElement.PointerEnteredEvent
InputElement.PointerExitedEvent
InputElement.PointerMovedEvent
InputElement.PointerPressedEvent
InputElement.PointerReleasedEvent
InputElement.PointerCaptureLostEvent
InputElement.PointerWheelChangedEvent
InputElement.TappedEvent
InputElement.HoldingEvent
InputElement.DoubleTappedEvent
InputElement.Focus(NavigationMethod, KeyModifiers)
InputElement.OnTextInput(TextInputEventArgs)
InputElement.OnPointerEntered(PointerEventArgs)
InputElement.OnPointerExited(PointerEventArgs)
InputElement.OnPointerCaptureLost(PointerCaptureLostEventArgs)
InputElement.UpdateIsEffectivelyEnabled()
InputElement.Focusable
InputElement.IsEnabled
InputElement.Cursor
InputElement.IsKeyboardFocusWithin
InputElement.IsFocused
InputElement.IsHitTestVisible
InputElement.IsPointerOver
InputElement.IsTabStop
InputElement.IsEffectivelyEnabled
InputElement.TabIndex
InputElement.KeyBindings
InputElement.IsEnabledCore
InputElement.GestureRecognizers
InputElement.GotFocus
InputElement.LostFocus
InputElement.KeyDown
InputElement.KeyUp
InputElement.TextInput
InputElement.TextInputMethodClientRequested
InputElement.PointerEntered
InputElement.PointerExited
InputElement.PointerMoved
InputElement.PointerPressed
InputElement.PointerReleased
InputElement.PointerCaptureLost
InputElement.PointerWheelChanged
InputElement.Tapped
InputElement.Holding
InputElement.DoubleTapped
Interactive.RaiseEvent(RoutedEventArgs)
Interactive.BuildEventRoute(RoutedEvent)
Layoutable.DesiredSizeProperty
Layoutable.WidthProperty
Layoutable.HeightProperty
Layoutable.MinWidthProperty
Layoutable.MaxWidthProperty
Layoutable.MinHeightProperty
Layoutable.MaxHeightProperty
Layoutable.MarginProperty
Layoutable.HorizontalAlignmentProperty
Layoutable.VerticalAlignmentProperty
Layoutable.UseLayoutRoundingProperty
Layoutable.UpdateLayout()
Layoutable.Measure(Size)
Layoutable.Arrange(Rect)
Layoutable.InvalidateMeasure()
Layoutable.InvalidateArrange()
Layoutable.AffectsMeasure<T>(params AvaloniaProperty[])
Layoutable.AffectsArrange<T>(params AvaloniaProperty[])
Layoutable.MeasureCore(Size)
Layoutable.ArrangeCore(Rect)
Layoutable.ArrangeOverride(Size)
Layoutable.OnMeasureInvalidated()
Layoutable.OnVisualParentChanged(Visual, Visual)
Layoutable.Width
Layoutable.Height
Layoutable.MinWidth
Layoutable.MaxWidth
Layoutable.MinHeight
Layoutable.MaxHeight
Layoutable.Margin
Layoutable.HorizontalAlignment
Layoutable.VerticalAlignment
Layoutable.DesiredSize
Layoutable.IsMeasureValid
Layoutable.IsArrangeValid
Layoutable.UseLayoutRounding
Layoutable.EffectiveViewportChanged
Layoutable.LayoutUpdated
Visual.BoundsProperty
Visual.ClipToBoundsProperty
Visual.ClipProperty
Visual.IsVisibleProperty
Visual.OpacityProperty
Visual.OpacityMaskProperty
Visual.EffectProperty
Visual.HasMirrorTransformProperty
Visual.RenderTransformProperty
Visual.RenderTransformOriginProperty
Visual.FlowDirectionProperty
Visual.VisualParentProperty
Visual.ZIndexProperty
Visual.GetFlowDirection(Visual)
Visual.SetFlowDirection(Visual, FlowDirection)
Visual.InvalidateVisual()
Visual.Render(DrawingContext)
Visual.AffectsRender<T>(params AvaloniaProperty[])
Visual.OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)
Visual.OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)
Visual.InvalidateMirrorTransform()
Visual.Bounds
Visual.ClipToBounds
Visual.Clip
Visual.IsEffectivelyVisible
Visual.IsVisible
Visual.Opacity
Visual.OpacityMask
Visual.Effect
Visual.HasMirrorTransform
Visual.RenderTransform
Visual.RenderTransformOrigin
Visual.FlowDirection
Visual.ZIndex
Visual.VisualChildren
Visual.VisualRoot
Visual.BypassFlowDirectionPolicies
Visual.AttachedToVisualTree
Visual.DetachedFromVisualTree
StyledElement.DataContextProperty
StyledElement.NameProperty
StyledElement.ParentProperty
StyledElement.TemplatedParentProperty
StyledElement.ThemeProperty
StyledElement.BeginInit()
StyledElement.EndInit()
StyledElement.ApplyStyling()
StyledElement.InitializeIfNeeded()
StyledElement.OnDataContextBeginUpdate()
StyledElement.OnDataContextEndUpdate()
StyledElement.OnInitialized()
StyledElement.Name
StyledElement.Classes
StyledElement.DataContext
StyledElement.IsInitialized
StyledElement.Styles
StyledElement.StyleKey
StyledElement.Resources
StyledElement.TemplatedParent
StyledElement.Theme
StyledElement.LogicalChildren
StyledElement.PseudoClasses
StyledElement.StyleKeyOverride
StyledElement.Parent
StyledElement.ActualThemeVariant
StyledElement.AttachedToLogicalTree
StyledElement.DetachedFromLogicalTree
StyledElement.DataContextChanged
StyledElement.Initialized
StyledElement.ResourcesChanged
StyledElement.ActualThemeVariantChanged
Animatable.TransitionsProperty
Animatable.OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)
Animatable.Transitions
AvaloniaObject.CheckAccess()
AvaloniaObject.VerifyAccess()
AvaloniaObject.ClearValue(AvaloniaProperty)
AvaloniaObject.ClearValue<T>(AvaloniaProperty<T>)
AvaloniaObject.ClearValue<T>(StyledProperty<T>)
AvaloniaObject.ClearValue<T>(DirectPropertyBase<T>)
AvaloniaObject.GetHashCode()
AvaloniaObject.GetValue(AvaloniaProperty)
AvaloniaObject.GetValue<T>(StyledProperty<T>)
AvaloniaObject.GetValue<T>(DirectPropertyBase<T>)
AvaloniaObject.GetBaseValue<T>(StyledProperty<T>)
AvaloniaObject.IsAnimating(AvaloniaProperty)
AvaloniaObject.IsSet(AvaloniaProperty)
AvaloniaObject.SetValue<T>(StyledProperty<T>, T, BindingPriority)
AvaloniaObject.SetValue<T>(DirectPropertyBase<T>, T)
AvaloniaObject.SetCurrentValue<T>(StyledProperty<T>, T)
AvaloniaObject.Bind(AvaloniaProperty, IBinding)
AvaloniaObject.CoerceValue(AvaloniaProperty)
AvaloniaObject.RaisePropertyChanged<T>(DirectPropertyBase<T>, T, T)
AvaloniaObject.SetAndRaise<T>(DirectPropertyBase<T>, ref T, T)
AvaloniaObject.InheritanceParent
AvaloniaObject.this[AvaloniaProperty]
AvaloniaObject.this[IndexerDescriptor]
AvaloniaObject.PropertyChanged
Extension Methods

Constructors

Viewport3DX()

Initializes a new instance of the Viewport3DX class.

public Viewport3DX()

Fields

AllowLeftRightRotationProperty 

public static readonly AvaloniaProperty AllowLeftRightRotationProperty

Field Value

AvaloniaProperty

AllowUpDownRotationProperty 

public static readonly AvaloniaProperty AllowUpDownRotationProperty

Field Value

AvaloniaProperty

BackgroundColorProperty

Background Color property.this.RenderHost

public static readonly AvaloniaProperty BackgroundColorProperty

Field Value

AvaloniaProperty

BelongsToParentWindowProperty

The belongs to parent window property

public static readonly AvaloniaProperty BelongsToParentWindowProperty

Field Value

AvaloniaProperty

CameraChangedEvent

The camera changed event.

public static readonly RoutedEvent<RoutedEventArgs> CameraChangedEvent

Field Value

RoutedEvent<RoutedEventArgs>

CameraInertiaFactorProperty

The camera inertia factor property.

public static readonly AvaloniaProperty CameraInertiaFactorProperty

Field Value

AvaloniaProperty

CameraModeProperty

The camera mode property

public static readonly AvaloniaProperty CameraModeProperty

Field Value

AvaloniaProperty

CameraProperty

The camera property

public static readonly AvaloniaProperty CameraProperty

Field Value

AvaloniaProperty

CameraRotationModeProperty

The camera rotation mode property

public static readonly AvaloniaProperty CameraRotationModeProperty

Field Value

AvaloniaProperty

ChangeFieldOfViewCursorProperty

The change fov cursor property.

public static readonly AvaloniaProperty ChangeFieldOfViewCursorProperty

Field Value

AvaloniaProperty

Content2DProperty

The content 2d property

public static readonly AvaloniaProperty Content2DProperty

Field Value

AvaloniaProperty

CoordinateSystemAxisXColorProperty

The coordinate system color X property

public static readonly AvaloniaProperty CoordinateSystemAxisXColorProperty

Field Value

AvaloniaProperty

CoordinateSystemAxisYColorProperty

The coordinate system Color Y property

public static readonly AvaloniaProperty CoordinateSystemAxisYColorProperty

Field Value

AvaloniaProperty

CoordinateSystemAxisZColorProperty

The coordinate system Color Z property

public static readonly AvaloniaProperty CoordinateSystemAxisZColorProperty

Field Value

AvaloniaProperty

CoordinateSystemHorizontalPositionProperty

The coordinate system horizontal position property. Relative to viewport center

Default: -0.8

public static readonly AvaloniaProperty CoordinateSystemHorizontalPositionProperty

Field Value

AvaloniaProperty

CoordinateSystemLabelForegroundProperty

The coordinate system label foreground property

public static readonly AvaloniaProperty CoordinateSystemLabelForegroundProperty

Field Value

AvaloniaProperty

CoordinateSystemLabelXProperty

The coordinate system label X property

public static readonly AvaloniaProperty CoordinateSystemLabelXProperty

Field Value

AvaloniaProperty

CoordinateSystemLabelYProperty

The coordinate system label Y property

public static readonly AvaloniaProperty CoordinateSystemLabelYProperty

Field Value

AvaloniaProperty

CoordinateSystemLabelZProperty

The coordinate system label Z property

public static readonly AvaloniaProperty CoordinateSystemLabelZProperty

Field Value

AvaloniaProperty

CoordinateSystemSizeProperty

The coordinate system size property.

public static readonly AvaloniaProperty CoordinateSystemSizeProperty

Field Value

AvaloniaProperty

CoordinateSystemVerticalPositionProperty

The coordinate system vertical position property. Relative to viewport center.

Default: -0.8

public static readonly AvaloniaProperty CoordinateSystemVerticalPositionProperty

Field Value

AvaloniaProperty

CursorOnElementPositionProperty

Identifies the CursorOnElementPosition dependency property.

public static readonly AvaloniaProperty CursorOnElementPositionProperty

Field Value

AvaloniaProperty

Remarks

This property returns the position of the nearest model.

CursorPositionProperty

Identifies the CursorPosition dependency property.

public static readonly AvaloniaProperty CursorPositionProperty

Field Value

AvaloniaProperty

Remarks

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

DefaultCameraProperty

The default camera property.

public static readonly AvaloniaProperty DefaultCameraProperty

Field Value

AvaloniaProperty

DpiScaleProperty

The dpi scale

public static readonly AvaloniaProperty DpiScaleProperty

Field Value

AvaloniaProperty

EffectsManagerProperty

The EffectsManager property.

public static readonly AvaloniaProperty EffectsManagerProperty

Field Value

AvaloniaProperty

EnableAutoOctreeUpdateProperty

The enable automatic octree update property

public static readonly AvaloniaProperty EnableAutoOctreeUpdateProperty

Field Value

AvaloniaProperty

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 AvaloniaProperty EnableCursorPositionProperty

Field Value

AvaloniaProperty

EnableD2DRenderingProperty

The enable d2d rendering property

public static readonly AvaloniaProperty EnableD2DRenderingProperty

Field Value

AvaloniaProperty

EnableDeferredRenderingProperty

Enable deferred rendering. Use multithreading to call rendering procedure using different Deferred Context.

Deferred Rendering: https://msdn.microsoft.com/en-us/library/windows/desktop/ff476892.aspx

https://docs.nvidia.com/gameworks/content/gameworkslibrary/graphicssamples/d3d_samples/d3d11deferredcontextssample.htm

Note: Only if draw calls > 3000 to be benefit according to the online performance test.

public static readonly AvaloniaProperty EnableDeferredRenderingProperty

Field Value

AvaloniaProperty

EnableDesignModeRenderingProperty

The enable design mode rendering property

public static readonly AvaloniaProperty EnableDesignModeRenderingProperty

Field Value

AvaloniaProperty

EnableDpiScaleProperty

The enable dpi scale property

public static readonly AvaloniaProperty EnableDpiScaleProperty

Field Value

AvaloniaProperty

EnableMouseButtonHitTestProperty

Enable mouse button hit test

public static readonly AvaloniaProperty EnableMouseButtonHitTestProperty

Field Value

AvaloniaProperty

EnableOITDepthPeelingDynamicIterationProperty 

public static readonly AvaloniaProperty EnableOITDepthPeelingDynamicIterationProperty

Field Value

AvaloniaProperty

EnableRenderFrustumProperty

Enable render frustum to avoid rendering model if it is out of view frustum

public static readonly AvaloniaProperty EnableRenderFrustumProperty

Field Value

AvaloniaProperty

EnableRenderOrderProperty

The enable render order property. EnableRenderOrder

public static readonly AvaloniaProperty EnableRenderOrderProperty

Field Value

AvaloniaProperty

EnableSSAOProperty

The enable ssao property

public static readonly AvaloniaProperty EnableSSAOProperty

Field Value

AvaloniaProperty

EnableSharedModelModeProperty

Used to create multiple viewport with shared models.

public static readonly AvaloniaProperty EnableSharedModelModeProperty

Field Value

AvaloniaProperty

FXAALevelProperty

The fxaa level property

public static readonly AvaloniaProperty FXAALevelProperty

Field Value

AvaloniaProperty

FieldOfViewTextProperty

The field of view text property.

public static readonly AvaloniaProperty FieldOfViewTextProperty

Field Value

AvaloniaProperty

FixedRotationPointEnabledProperty

Enable fixed rotation mode and use FixedRotationPoint for rotation. Only works under CameraMode = Inspect

public static readonly AvaloniaProperty FixedRotationPointEnabledProperty

Field Value

AvaloniaProperty

FixedRotationPointProperty

Rotate around this fixed rotation point only.FixedRotationPointEnabledProperty

public static readonly AvaloniaProperty FixedRotationPointProperty

Field Value

AvaloniaProperty

FrameRateProperty

The frame rate property.

public static readonly AvaloniaProperty FrameRateProperty

Field Value

AvaloniaProperty

FrameRateTextProperty

The frame rate text property.

public static readonly AvaloniaProperty FrameRateTextProperty

Field Value

AvaloniaProperty

IncreaseSwapchainFPSProperty 

public static readonly AvaloniaProperty IncreaseSwapchainFPSProperty

Field Value

AvaloniaProperty

InfiniteSpinProperty

The infinite spin property.

public static readonly AvaloniaProperty InfiniteSpinProperty

Field Value

AvaloniaProperty

InfoBackgroundProperty

The info background property.

public static readonly AvaloniaProperty InfoBackgroundProperty

Field Value

AvaloniaProperty

InfoForegroundProperty

The info foreground property.

public static readonly AvaloniaProperty InfoForegroundProperty

Field Value

AvaloniaProperty

IsChangeFieldOfViewEnabledProperty

The is change field of view enabled property

public static readonly AvaloniaProperty IsChangeFieldOfViewEnabledProperty

Field Value

AvaloniaProperty

IsCoordinateSystemMoverEnabledProperty

The is coordinate system mover enabled property

public static readonly AvaloniaProperty IsCoordinateSystemMoverEnabledProperty

Field Value

AvaloniaProperty

IsInertiaEnabledProperty

Identifies the IsInertiaEnabled dependency property.

public static readonly AvaloniaProperty IsInertiaEnabledProperty

Field Value

AvaloniaProperty

IsMoveEnabledProperty

The is move enabled property.

public static readonly AvaloniaProperty IsMoveEnabledProperty

Field Value

AvaloniaProperty

IsPanEnabledProperty

The is pan enabled property

public static readonly AvaloniaProperty IsPanEnabledProperty

Field Value

AvaloniaProperty

IsPinchZoomEnabledProperty

The IsTouchZoomEnabled property.

public static readonly AvaloniaProperty IsPinchZoomEnabledProperty

Field Value

AvaloniaProperty

IsRotationEnabledProperty

The is rotation enabled property

public static readonly AvaloniaProperty IsRotationEnabledProperty

Field Value

AvaloniaProperty

IsShadowMappingEnabledProperty

The is deferred shading enabled propery

public static readonly AvaloniaProperty IsShadowMappingEnabledProperty

Field Value

AvaloniaProperty

IsThreeFingerPanningEnabledProperty

The enable touch rotate property

public static readonly AvaloniaProperty IsThreeFingerPanningEnabledProperty

Field Value

AvaloniaProperty

IsTouchRotateEnabledProperty

The enable touch rotate property

public static readonly AvaloniaProperty IsTouchRotateEnabledProperty

Field Value

AvaloniaProperty

IsViewCubeEdgeClicksEnabledProperty

Identifies the IsViewCubeEdgeClicksEnabled dependency property.

public static readonly AvaloniaProperty IsViewCubeEdgeClicksEnabledProperty

Field Value

AvaloniaProperty

IsViewCubeMoverEnabledProperty

Identifies the IsViewCubeEdgeClicksEnabled dependency property.

public static readonly AvaloniaProperty IsViewCubeMoverEnabledProperty

Field Value

AvaloniaProperty

IsZoomEnabledProperty

The is zoom enabled property

public static readonly AvaloniaProperty IsZoomEnabledProperty

Field Value

AvaloniaProperty

LeftRightPanSensitivityProperty

The left right pan sensitivity property.

public static readonly AvaloniaProperty LeftRightPanSensitivityProperty

Field Value

AvaloniaProperty

LeftRightRotationSensitivityProperty

The left right rotation sensitivity property.

public static readonly AvaloniaProperty LeftRightRotationSensitivityProperty

Field Value

AvaloniaProperty

MSAAProperty

Set MSAA Level

public static readonly AvaloniaProperty MSAAProperty

Field Value

AvaloniaProperty

ManualLookAtPointProperty

Manually move camera to look at a point in 3D space

public static readonly AvaloniaProperty ManualLookAtPointProperty

Field Value

AvaloniaProperty

MaximumFieldOfViewProperty

The maximum field of view property

public static readonly AvaloniaProperty MaximumFieldOfViewProperty

Field Value

AvaloniaProperty

MessageTextProperty

The message text property.

public static readonly AvaloniaProperty MessageTextProperty

Field Value

AvaloniaProperty

MinimumFieldOfViewProperty

The minimum field of view property

public static readonly AvaloniaProperty MinimumFieldOfViewProperty

Field Value

AvaloniaProperty

MinimumUpdateCountProperty

The minimum update count property

public static readonly AvaloniaProperty MinimumUpdateCountProperty

Field Value

AvaloniaProperty

ModelUpDirectionProperty

The model up direction property

public static readonly AvaloniaProperty ModelUpDirectionProperty

Field Value

AvaloniaProperty

MoveSensitivityProperty

Identifies the MoveSensitivity dependency property.

public static readonly AvaloniaProperty MoveSensitivityProperty

Field Value

AvaloniaProperty

OITDepthPeelingIterationProperty 

public static readonly AvaloniaProperty OITDepthPeelingIterationProperty

Field Value

AvaloniaProperty

OITRenderModeProperty

Gets or sets a value indicating for Transparent objects render mode. IsTransparent, IsTransparent

public static readonly AvaloniaProperty OITRenderModeProperty

Field Value

AvaloniaProperty

OITWeightDepthSlopeProperty

The oit weight depth slope property

public static readonly AvaloniaProperty OITWeightDepthSlopeProperty

Field Value

AvaloniaProperty

OITWeightModeProperty

The oit weight mode property

Please refer to http://jcgt.org/published/0002/02/09/

Linear0: eq7; Linear1: eq8; Linear2: eq9; NonLinear: eq10

public static readonly AvaloniaProperty OITWeightModeProperty

Field Value

AvaloniaProperty

OITWeightPowerProperty

The Order independent transparency rendering color weight power property

public static readonly AvaloniaProperty OITWeightPowerProperty

Field Value

AvaloniaProperty

OrthographicProperty

The orthographic property.

public static readonly AvaloniaProperty OrthographicProperty

Field Value

AvaloniaProperty

PageUpDownZoomSensitivityProperty

Identifies the PageUpDownZoomSensitivity dependency property.

public static readonly AvaloniaProperty PageUpDownZoomSensitivityProperty

Field Value

AvaloniaProperty

PanCursorProperty

The pan cursor property

public static readonly AvaloniaProperty PanCursorProperty

Field Value

AvaloniaProperty

PinchZoomAtCenterProperty

The pinch zoom at center property

public static readonly AvaloniaProperty PinchZoomAtCenterProperty

Field Value

AvaloniaProperty

RenderDetailOutputProperty

The render detail output property

public static readonly AvaloniaProperty RenderDetailOutputProperty

Field Value

AvaloniaProperty

RenderExceptionProperty

The render exception property.

public static readonly AvaloniaProperty RenderExceptionProperty

Field Value

AvaloniaProperty

RotateAroundMouseDownPointProperty

The rotate around mouse down point property

public static readonly AvaloniaProperty RotateAroundMouseDownPointProperty

Field Value

AvaloniaProperty

RotateCursorProperty

The rotate cursor property

public static readonly AvaloniaProperty RotateCursorProperty

Field Value

AvaloniaProperty

RotationSensitivityProperty

The rotation sensitivity property

public static readonly AvaloniaProperty RotationSensitivityProperty

Field Value

AvaloniaProperty

SSAOIntensityProperty

The ssao intensity property

public static readonly AvaloniaProperty SSAOIntensityProperty

Field Value

AvaloniaProperty

SSAOQualityProperty

The ssao quality property

public static readonly AvaloniaProperty SSAOQualityProperty

Field Value

AvaloniaProperty

SSAOSamplingRadiusProperty

The ssao sampling radius property

public static readonly AvaloniaProperty SSAOSamplingRadiusProperty

Field Value

AvaloniaProperty

SharedModelContainerProperty

Binding to the element inherit with IModelContainer

public static readonly AvaloniaProperty SharedModelContainerProperty

Field Value

AvaloniaProperty

ShowCameraInfoProperty

The show camera info property.

public static readonly AvaloniaProperty ShowCameraInfoProperty

Field Value

AvaloniaProperty

ShowCameraTargetProperty

The show camera target property.

public static readonly AvaloniaProperty ShowCameraTargetProperty

Field Value

AvaloniaProperty

ShowCoordinateSystemProperty

The show coordinate system property.

public static readonly AvaloniaProperty ShowCoordinateSystemProperty

Field Value

AvaloniaProperty

ShowFrameDetailsProperty

The show frame rate property.

public static readonly AvaloniaProperty ShowFrameDetailsProperty

Field Value

AvaloniaProperty

ShowFrameRateProperty

The show frame rate property.

public static readonly AvaloniaProperty ShowFrameRateProperty

Field Value

AvaloniaProperty

ShowTriangleCountInfoProperty

The show triangle count info property.

public static readonly AvaloniaProperty ShowTriangleCountInfoProperty

Field Value

AvaloniaProperty

ShowViewCubeProperty

The show view cube property.

public static readonly AvaloniaProperty ShowViewCubeProperty

Field Value

AvaloniaProperty

SpinReleaseTimeProperty

The spin release time property

public static readonly AvaloniaProperty SpinReleaseTimeProperty

Field Value

AvaloniaProperty

SubTitleProperty

The sub title property.

public static readonly AvaloniaProperty SubTitleProperty

Field Value

AvaloniaProperty

SubTitleSizeProperty

The sub title size property.

public static readonly AvaloniaProperty SubTitleSizeProperty

Field Value

AvaloniaProperty

TextBrushProperty

The text brush property.

public static readonly AvaloniaProperty TextBrushProperty

Field Value

AvaloniaProperty

TitleBackgroundProperty

The title background property.

public static readonly AvaloniaProperty TitleBackgroundProperty

Field Value

AvaloniaProperty

TitleFontFamilyProperty

The title font family property.

public static readonly AvaloniaProperty TitleFontFamilyProperty

Field Value

AvaloniaProperty

TitleProperty

The title property.

public static readonly AvaloniaProperty TitleProperty

Field Value

AvaloniaProperty

TitleSizeProperty

The title size property.

public static readonly AvaloniaProperty TitleSizeProperty

Field Value

AvaloniaProperty

UpDownPanSensitivityProperty

The up down Pan sensitivity property.

public static readonly AvaloniaProperty UpDownPanSensitivityProperty

Field Value

AvaloniaProperty

UpDownRotationSensitivityProperty

The up down rotation sensitivity property.

public static readonly AvaloniaProperty UpDownRotationSensitivityProperty

Field Value

AvaloniaProperty

UseDefaultGesturesProperty

The use default gestures property

public static readonly AvaloniaProperty UseDefaultGesturesProperty

Field Value

AvaloniaProperty

ViewCubeHorizontalPositionProperty

The view cube horizontal position property. Relative to viewport center.

Default: 0.8

public static readonly AvaloniaProperty ViewCubeHorizontalPositionProperty

Field Value

AvaloniaProperty

ViewCubeSizeProperty

The view cube size property.

public static readonly AvaloniaProperty ViewCubeSizeProperty

Field Value

AvaloniaProperty

ViewCubeTextureProperty

The view cube texture. It must be a 6x1 (ex: 600x100) ratio image. You can also use BitmapExtension.CreateViewBoxBitmapSource to create

public static readonly AvaloniaProperty ViewCubeTextureProperty

Field Value

AvaloniaProperty

ViewCubeVerticalPositionProperty

The view cube vertical position property. Relative to viewport center.

Default: -0.8

public static readonly AvaloniaProperty ViewCubeVerticalPositionProperty

Field Value

AvaloniaProperty

ZoomAroundMouseDownPointProperty

The zoom around mouse down point property

public static readonly AvaloniaProperty ZoomAroundMouseDownPointProperty

Field Value

AvaloniaProperty

ZoomCursorProperty

The zoom cursor property

public static readonly AvaloniaProperty ZoomCursorProperty

Field Value

AvaloniaProperty

ZoomDistanceLimitFarProperty

The far zoom distance limit property.

public static readonly AvaloniaProperty ZoomDistanceLimitFarProperty

Field Value

AvaloniaProperty

ZoomDistanceLimitNearProperty

The near zoom distance limit property.

public static readonly AvaloniaProperty ZoomDistanceLimitNearProperty

Field Value

AvaloniaProperty

ZoomExtentsWhenLoadedProperty

The zoom extents when loaded property.

public static readonly AvaloniaProperty ZoomExtentsWhenLoadedProperty

Field Value

AvaloniaProperty

ZoomRectangleCursorProperty

The zoom rectangle cursor property

public static readonly AvaloniaProperty ZoomRectangleCursorProperty

Field Value

AvaloniaProperty

ZoomSensitivityProperty

The zoom sensitivity property

public static readonly AvaloniaProperty ZoomSensitivityProperty

Field Value

AvaloniaProperty

renderHostInternal

Gets or sets the render host internal.

protected IRenderHost? renderHostInternal

Field Value

IRenderHost

The render host internal.

Properties

ActualHeight 

public double ActualHeight { get; }

Property Value

double

ActualWidth 

public double ActualWidth { get; }

Property Value

double

AllowLeftRightRotation

Gets or sets a value indicating whether globally [allow left right rotation].

public bool AllowLeftRightRotation { get; set; }

Property Value

bool

true if [allow left right rotation]; otherwise, false.

AllowUpDownRotation

Gets or sets a value indicating whether globally [allow up down rotation].

public bool AllowUpDownRotation { get; set; }

Property Value

bool

true if [allow up down rotation]; otherwise, false.

BackgroundColor

Background Color

public Color BackgroundColor { get; set; }

Property Value

Color

BelongsToParentWindow

Gets or sets a value indicating if the life cycle of the viewport depends on the first parent window found in the actual visual tree.

public bool BelongsToParentWindow { get; set; }

Property Value

bool

true if the viewport belongs to the first parent window; otherwise, false

Camera

Gets or sets the camera.

public Camera? Camera { get; set; }

Property Value

Camera

The camera.

CameraCore

Gets the camera core.

public CameraCore? CameraCore { get; }

Property Value

CameraCore

The camera core.

CameraInertiaFactor

Gets or sets the camera inertia factor.

public double CameraInertiaFactor { get; set; }

Property Value

double

The camera inertia factor.

CameraMode

Gets or sets the camera mode.

public CameraMode CameraMode { get; set; }

Property Value

CameraMode

The camera mode.

CameraRotationMode

Gets or sets the camera rotation mode.

public CameraRotationMode CameraRotationMode { get; set; }

Property Value

CameraRotationMode

The camera rotation mode.

ChangeFieldOfViewCursor

Gets or sets the change field of view cursor.

public Cursor ChangeFieldOfViewCursor { get; set; }

Property Value

Cursor

The change field of view cursor.

Content2D

Gets or sets the content2d.

public Element2D? Content2D { get; set; }

Property Value

Element2D

The content2 d.

CoordinateSystemAxisXColor

Gets or sets the coordinate system color X.

public Color CoordinateSystemAxisXColor { get; set; }

Property Value

Color

The coordinate system color X.

CoordinateSystemAxisYColor

Gets or sets the coordinate system color Y.

public Color CoordinateSystemAxisYColor { get; set; }

Property Value

Color

The coordinate system color T.

CoordinateSystemAxisZColor

Gets or sets the coordinate system color Z.

public Color CoordinateSystemAxisZColor { get; set; }

Property Value

Color

The coordinate system color Z.

CoordinateSystemHorizontalPosition

Gets or sets the horizontal position of the coordinate system viewport. Relative to the viewport center.

Default: -0.8

public double CoordinateSystemHorizontalPosition { get; set; }

Property Value

double

The horizontal position.

CoordinateSystemLabelForeground

Gets or sets the color of the coordinate system label.

public Color CoordinateSystemLabelForeground { get; set; }

Property Value

Color

The color of the coordinate system label.

CoordinateSystemLabelX

Gets or sets the coordinate system label X.

public string CoordinateSystemLabelX { get; set; }

Property Value

string

The coordinate system label X.

CoordinateSystemLabelY

Gets or sets the coordinate system label Y.

public string CoordinateSystemLabelY { get; set; }

Property Value

string

The coordinate system label Y.

CoordinateSystemLabelZ

Gets or sets the coordinate system label Z.

public string CoordinateSystemLabelZ { get; set; }

Property Value

string

The coordinate system label Z.

CoordinateSystemSize

Gets or sets the width of the coordinate system viewport.

public double CoordinateSystemSize { get; set; }

Property Value

double

The width of the coordinate system viewport.

CoordinateSystemVerticalPosition

Gets or sets the vertical position of the coordinate system viewport. Relative to the viewport center

Default: -0.8

public double CoordinateSystemVerticalPosition { get; set; }

Property Value

double

The vertical position.

CursorOnElementPosition

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

public Vector3? CursorOnElementPosition { get; }

Property Value

Vector3?

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 Vector3? CursorPosition { get; }

Property Value

Vector3?

The current cursor position.

Remarks

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

D2DRenderables

Gets the d2d renderables.

public IEnumerable<SceneNode2D> D2DRenderables { get; }

Property Value

IEnumerable<SceneNode2D>

The d2d renderables.

DefaultCamera

Gets or sets the default camera.

public ProjectionCamera? DefaultCamera { get; set; }

Property Value

ProjectionCamera

The default camera.

DpiScale

Gets or sets the dpi scale. For example, if dpi scale is set to 200% in windows, this value must be set to 2.

public double DpiScale { get; set; }

Property Value

double

The dpi scale.

EffectsManager

Gets or sets the IEffectsManager.

public IEffectsManager? EffectsManager { get; set; }

Property Value

IEffectsManager

EnableAutoOctreeUpdate

Gets or sets a value indicating whether [enable automatic update octree for geometry models].

public bool EnableAutoOctreeUpdate { get; set; }

Property Value

bool

true if [enable automatic octree update]; otherwise, false.

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 .

EnableD2DRendering

Gets or sets a value indicating whether [enable direct2D rendering]. Default is On

public bool EnableD2DRendering { get; set; }

Property Value

bool

true if [render d2d]; otherwise, false.

EnableDeferredRendering

Enable deferred rendering. Use multithreading to call rendering procedure using different Deferred Context.

Deferred Rendering: https://msdn.microsoft.com/en-us/library/windows/desktop/ff476892.aspx

https://docs.nvidia.com/gameworks/content/gameworkslibrary/graphicssamples/d3d_samples/d3d11deferredcontextssample.htm

Note: Only if draw calls > 3000 to be benefit according to the online performance test.

public bool EnableDeferredRendering { get; set; }

Property Value

bool

EnableDesignModeRendering

Gets or sets a value indicating whether [enable design mode rendering].

public bool EnableDesignModeRendering { get; set; }

Property Value

bool

true if [enable design mode rendering]; otherwise, false.

EnableDpiScale

Gets or sets a value indicating whether [enable dpi scale]. Enable this option if you want to render high definition image with using high definition monitor and using dpi scaling in windows. This option may impact rendering performance due to higher resolution.

public bool EnableDpiScale { get; set; }

Property Value

bool

true if [enable dpi scale]; otherwise, false.

EnableMouseButtonHitTest

Enable mouse button hit test

public bool EnableMouseButtonHitTest { get; set; }

Property Value

bool

EnableOITDepthPeelingDynamicIteration 

public bool EnableOITDepthPeelingDynamicIteration { get; set; }

Property Value

bool

EnableRenderFrustum

Enable render frustum to skip rendering model if model is out of the camera bounding frustum

public bool EnableRenderFrustum { get; set; }

Property Value

bool

EnableRenderOrder

Gets or sets a value indicating whether [enable render order]. Specify render order in RenderOrder. Scene node will be sorted by the RenderOrder during rendering.

public bool EnableRenderOrder { get; set; }

Property Value

bool

true if [enable manual render order]; otherwise, false.

EnableSSAO

Gets or sets a value indicating whether [enable ScreenSpaced Ambient Occlusion].

public bool EnableSSAO { get; set; }

Property Value

bool

true if [enable ssao]; otherwise, false.

EnableSharedModelMode

Used to create multiple viewport with shared models.

public bool EnableSharedModelMode { get; set; }

Property Value

bool

FXAALevel

Gets or sets the fxaa. If MSAA is set, FXAA will be disabled automatically

public FXAALevel FXAALevel { get; set; }

Property Value

FXAALevel

The enable fxaa.

FieldOfViewText

Gets or sets the field of view text.

public string? FieldOfViewText { get; set; }

Property Value

string

The field of view text.

FixedRotationPoint

Rotate around this fixed rotation point only.FixedRotationPointEnabled

public Vector3 FixedRotationPoint { get; set; }

Property Value

Vector3

FixedRotationPointEnabled

Enable fixed rotation mode and use FixedRotationPoint for rotation. Only works under CameraMode = Inspect

public bool FixedRotationPointEnabled { get; set; }

Property Value

bool

FrameRate

Gets or sets the frame rate.

public double FrameRate { get; set; }

Property Value

double

The frame rate.

FrameRateText

Gets or sets the frame rate text.

public string? FrameRateText { get; set; }

Property Value

string

The frame rate text.

IncreaseSwapchainFPS

Increase swapchain fps by speed up the wpf composition target frame rate. This may negatively impact the performance on low end graphics card. Default is enabled.

public bool IncreaseSwapchainFPS { get; set; }

Property Value

bool

InfiniteSpin

Gets or sets a value indicating whether infinite spin is enabled.

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 field of view is enabled.

public bool IsChangeFieldOfViewEnabled { get; set; }

Property Value

bool

true if change field of view is enabled; otherwise, false.

IsCoordinateSystemMoverEnabled

Gets or sets a value indicating whether coordinate system mover enabled.

public bool IsCoordinateSystemMoverEnabled { get; set; }

Property Value

bool

true if coordinate system mover enabled; otherwise, false.

IsInDesignMode 

public static bool IsInDesignMode { get; }

Property Value

bool

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 is enabled.

public bool IsMoveEnabled { get; set; }

Property Value

bool

true if move is enabled; otherwise, false .

IsPanEnabled

Gets or sets a value indicating whether pan is enabled.

public bool IsPanEnabled { get; set; }

Property Value

bool

true if pan is enabled; otherwise, false.

IsPinchZoomEnabled

Gets or sets a value indicating whether two finger pinch zoom is enabled.

public bool IsPinchZoomEnabled { get; set; }

Property Value

bool

true if pinch zoom is enabled; otherwise, false .

IsRotationEnabled

Gets or sets a value indicating whether rotation is enabled.

public bool IsRotationEnabled { get; set; }

Property Value

bool

true if rotation is enabled; otherwise, false.

IsShadowMappingEnabled

Gets or sets a value indicating whether shadow mapping is enabled

public bool IsShadowMappingEnabled { get; set; }

Property Value

bool

true if deferred shading is enabled; otherwise, false.

IsThreeFingerPanningEnabled

Gets or sets a value indicating whether [enable three finger panning].

public bool IsThreeFingerPanningEnabled { get; set; }

Property Value

bool

true if [enable three finger panning]; otherwise, false.

IsTouchRotateEnabled

Gets or sets a value indicating whether [enable one finger touch rotate].

public bool IsTouchRotateEnabled { get; set; }

Property Value

bool

true if [enable touch rotate]; otherwise, false.

IsViewCubeEdgeClicksEnabled

Gets or sets if the view cube edge clickable.

public bool IsViewCubeEdgeClicksEnabled { get; set; }

Property Value

bool

Boolean for enable or disable.

IsViewCubeMoverEnabled

Gets or sets a value indicating whether this instance is view cube mover enabled.

public bool IsViewCubeMoverEnabled { get; set; }

Property Value

bool

true if this instance is view cube mover enabled; otherwise, false.

IsZoomEnabled

Gets or sets a value indicating whether zoom is enabled.

public bool IsZoomEnabled { get; set; }

Property Value

bool

true if zoom is enabled; otherwise, false.

Items

Gets the items.

[Content]
public ObservableElement3DCollection Items { get; }

Property Value

ObservableElement3DCollection

The items.

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.

MSAA

Set MSAA level. If set to Two/Four/Eight, the actual level is set to minimum between Maximum and Two/Four/Eight

public MSAALevel MSAA { get; set; }

Property Value

MSAALevel

ManualLookAtPoint

Manually move camera to look at a point in 3D space. (Same as calling Viewport3DX.LookAt() function) Since camera may have been moved by mouse, the value gets does not reflect the actual point camera currently looking at.

public Vector3 ManualLookAtPoint { get; set; }

Property Value

Vector3

MaximumFieldOfView

Gets or sets the maximum field of view.

public double MaximumFieldOfView { get; set; }

Property Value

double

The maximum field of view.

MessageText

Gets or sets the message text.

public string? MessageText { get; set; }

Property Value

string

The message text.

MinimumFieldOfView

Gets or sets the minimum field of view.

public double MinimumFieldOfView { get; set; }

Property Value

double

The minimum field of view.

MinimumUpdateCount

The update count. Used to render at least N frames for each InvalidateRenderer. D3DImage sometimes not getting refresh if only render once. Default = 6.

public int MinimumUpdateCount { get; set; }

Property Value

int

The minimum update count.

ModelUpDirection

Gets or sets the model up direction.

public Vector3 ModelUpDirection { get; set; }

Property Value

Vector3

The model up direction.

MouseOverModel2D 

public Element2D? MouseOverModel2D { get; }

Property Value

Element2D

MoveSensitivity

Gets or sets the move sensitivity.

public double MoveSensitivity { get; set; }

Property Value

double

The move sensitivity.

OITDepthPeelingIteration

Sets or gets Order independent transparency depth peeling mode iteration.

public int OITDepthPeelingIteration { get; set; }

Property Value

int

OITRenderMode

Gets or sets order independent transparency render mode IsTransparent, IsTransparent

public OITRenderType OITRenderMode { get; set; }

Property Value

OITRenderType

true if [enable oit rendering]; otherwise, false.

OITWeightDepthSlope

Gets or sets the oit weight depth slope. Used to increase resolution for particular range of depth values.

If value = 2, the depth range from 0-0.5 expands to 0-1 to increase resolution. However, values from 0.5 - 1 will be pushed to 1

public double OITWeightDepthSlope { get; set; }

Property Value

double

The oit weight depth slope.

OITWeightMode

Gets or sets the oit weight mode.

Please refer to http://jcgt.org/published/0002/02/09/

Linear0: eq7; Linear1: eq8; Linear2: eq9; NonLinear: eq10

public OITWeightMode OITWeightMode { get; set; }

Property Value

OITWeightMode

The oit weight mode.

OITWeightPower

Gets or sets the Order independent transparency rendering color weight power. Used for color weight calculation.

Different near field/far field settings may need different power value for z value based weight calculation.

public double OITWeightPower { get; set; }

Property Value

double

The oit weight power.

Orthographic

Gets or sets a value indicating whether an orthographic camera should be used.

public bool Orthographic { get; set; }

Property Value

bool

true if orthographic; otherwise, false .

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.

PinchZoomAtCenter

Gets or sets a value indicating whether [pinch zoom at center] instead of at finger down point. Default is false.

public bool PinchZoomAtCenter { get; set; }

Property Value

bool

true if [pinch zoom at center]; otherwise, false.

RenderContext

Get current render context

public RenderContext? RenderContext { get; }

Property Value

RenderContext

RenderDetailOutput

Gets or sets the render detail output.

public string RenderDetailOutput { get; set; }

Property Value

string

The render detail output.

RenderException

Gets or sets the Exception that occured at rendering subsystem.

public Exception? RenderException { get; set; }

Property Value

Exception

RenderHost

Gets the render host.

public IRenderHost? RenderHost { get; }

Property Value

IRenderHost

The render host.

Renderables

Return enumerable of all the rederable elements

If enabled shared model mode, the returned rederables are current viewport renderable plus shared models

public IEnumerable<SceneNode> Renderables { get; }

Property Value

IEnumerable<SceneNode>

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 rotating around mouse down point; otherwise, false.

RotateCursor

Gets or sets the rotate cursor.

public Cursor RotateCursor { get; set; }

Property Value

Cursor

The rotate cursor.

RotationSensitivity

Gets or sets the rotation sensitivity.

public double RotationSensitivity { get; set; }

Property Value

double

The rotation sensitivity.

SSAOIntensity

Gets or sets the ssao intensity.

public double SSAOIntensity { get; set; }

Property Value

double

The ssao intensity.

SSAOQuality

Gets or sets the ssao quality.

public SSAOQuality SSAOQuality { get; set; }

Property Value

SSAOQuality

The ssao quality.

SSAOSamplingRadius

Gets or sets the ssao sampling radius.

public double SSAOSamplingRadius { get; set; }

Property Value

double

The ssao sampling radius.

SharedModelContainer

Binding to the element inherit with IModelContainer

public IModelContainer? SharedModelContainer { get; set; }

Property Value

IModelContainer

SharedModelContainerInternal

Gets or sets the shared model container internal.

protected IModelContainer? SharedModelContainerInternal { get; }

Property Value

IModelContainer

The shared model container internal.

ShowCameraInfo

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

public bool ShowCameraInfo { get; set; }

Property Value

bool

true if 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 camera target 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 coordinate system should be shown; otherwise, false .

ShowFrameDetails

Gets or sets a value indicating whether [show frame details].

public bool ShowFrameDetails { get; set; }

Property Value

bool

true if [show frame details]; otherwise, false.

ShowFrameRate

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

public bool ShowFrameRate { get; set; }

Property Value

bool

true if 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 .

SpinReleaseTime

Gets or sets the spin release time in milliseconds (maximum allowed time to start a spin).

public int SpinReleaseTime { get; set; }

Property Value

int

The spin release time (in milliseconds).

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 string? TitleFontFamily { get; set; }

Property Value

string

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.

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.

UseDefaultGestures

Gets or sets a value indicating whether to use default mouse/keyboard gestures.

public bool UseDefaultGestures { get; set; }

Property Value

bool

true if default gestures should be used; otherwise, false.

ViewCubeHorizontalPosition

Gets or sets the horizontal position of the view cube viewport. Relative to viewport center

Default: 0.8

public double ViewCubeHorizontalPosition { get; set; }

Property Value

double

The horizontal position.

ViewCubeSize

Gets or sets the width of the view cube viewport.

public double ViewCubeSize { get; set; }

Property Value

double

The width of the view cube viewport.

ViewCubeTexture

Gets or sets the view cube texture; The view cube texture. It must be a 6x1 (ex: 600x100) ratio image. You can also use BitmapExtension.CreateViewBoxBitmapSource to create

public TextureModel? ViewCubeTexture { get; set; }

Property Value

TextureModel

The view cube texture.

ViewCubeVerticalPosition

Gets or sets the vertical position of view cube viewport. Relative to viewport center

Default: -0.8

public double ViewCubeVerticalPosition { get; set; }

Property Value

double

The vertical position.

ViewportRectangle

Gets the viewport rectangle.

public Rectangle ViewportRectangle { get; }

Property Value

Rectangle

The viewport rectangle.

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; otherwise, false.

ZoomCursor

Gets or sets the zoom cursor.

public Cursor ZoomCursor { get; set; }

Property Value

Cursor

The zoom cursor.

ZoomDistanceLimitFar

Gets or sets a value indicating the far distance limit for zoom.

public double ZoomDistanceLimitFar { get; set; }

Property Value

double

ZoomDistanceLimitNear

Gets or sets a value indicating the near distance limit for zoom.

public double ZoomDistanceLimitNear { get; set; }

Property Value

double

ZoomExtentsWhenLoaded

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

public bool ZoomExtentsWhenLoaded { get; set; }

Property Value

bool

ZoomRectangleCursor

Gets or sets the zoom rectangle cursor.

public Cursor ZoomRectangleCursor { get; set; }

Property Value

Cursor

The zoom rectangle cursor.

ZoomSensitivity

Gets or sets the zoom sensitivity.

public double ZoomSensitivity { get; set; }

Property Value

double

The zoom sensitivity.

Methods

AddMoveForce(double, double, double)

Adds the specified move force.

public void AddMoveForce(double dx, double dy, double dz)

Parameters

dx double

The delta x.

dy double

The delta y.

dz double

The delta z.

AddMoveForce(Vector3)

Adds the specified move force.

public void AddMoveForce(Vector3 delta)

Parameters

delta Vector3

The delta.

AddPanForce(double, double)

Adds the specified pan force.

public void AddPanForce(double dx, double dy)

Parameters

dx double

The delta x.

dy double

The delta y.

AddPanForce(Vector3)

The add pan force.

public void AddPanForce(Vector3 pan)

Parameters

pan Vector3

The pan.

AddRotateForce(double, double)

The add rotate force.

public void AddRotateForce(double dx, double dy)

Parameters

dx double

The delta x.

dy double

The delta y.

AddZoomForce(double)

Adds the zoom force.

public void AddZoomForce(double dx)

Parameters

dx double

The delta.

AddZoomForce(double, Vector3)

Adds the zoom force.

public void AddZoomForce(double dx, Vector3 zoomOrigin)

Parameters

dx double

The delta.

zoomOrigin Vector3

The zoom origin.

Attach(IRenderHost)

Attaches the elements to the specified host.

public void Attach(IRenderHost host)

Parameters

host IRenderHost

The host.

ChangeDirection(Vector3, Vector3, double)

Changes the direction of the camera.

public void ChangeDirection(Vector3 lookDir, Vector3 upDir, double animationTime = 500)

Parameters

lookDir Vector3

The look direction.

upDir Vector3

The up direction.

animationTime double

The animation time.

Detach()

Detaches the elements.

public void Detach()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool) 

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

EmulateMouseDownByTouch(PointerPressedEventArgs) 

public void EmulateMouseDownByTouch(PointerPressedEventArgs e)

Parameters

e PointerPressedEventArgs

EmulateMouseMoveByTouch(Point)

Emulates the mouse move by touch.

public void EmulateMouseMoveByTouch(Point pt)

Parameters

pt Point

The pt.

EmulateMouseUpByTouch(PointerEventArgs) 

public void EmulateMouseUpByTouch(PointerEventArgs e)

Parameters

e PointerEventArgs

FindNearestPoint(Point)

Finds the nearest 3D point in the scene.

public Vector3? FindNearestPoint(Point pt)

Parameters

pt Point

The screen point (2D).

Returns

Vector3?

A Point3D or null.

FindVisualAncestor<T>(StyledElement) 

public static T? FindVisualAncestor<T>(StyledElement obj) where T : StyledElement

Parameters

obj StyledElement

Returns

T

Type Parameters

T

HideTargetAdorner()

Hides the target adorner.

public void HideTargetAdorner()

HideZoomRectangle()

Hides the zoom rectangle.

public void HideZoomRectangle()

HittedSomething(PointerEventArgs) 

public bool HittedSomething(PointerEventArgs e)

Parameters

e PointerEventArgs

Returns

bool

InvalidateRender()

Tries to invalidate the current render.

public void InvalidateRender()

InvalidateSceneGraph()

Invalidates the scene graph.

public void InvalidateSceneGraph()

IsModelUpDirectionY()

Determines whether the model up direction is (0,1,0).

public bool IsModelUpDirectionY()

Returns

bool

true if the up direction is (0,1,0); otherwise, false.

LookAt(Vector3)

Change the camera to look at the specified point.

public void LookAt(Vector3 p)

Parameters

p Vector3

The point.

LookAt(Vector3, double)

Change the camera to look at the specified point.

public void LookAt(Vector3 p, double animationTime)

Parameters

p Vector3

The point.

animationTime double

The animation time.

LookAt(Vector3, double, double)

Change the camera to look at the specified point.

public void LookAt(Vector3 p, double distance, double animationTime)

Parameters

p Vector3

The point.

distance double

The distance.

animationTime double

The animation time.

LookAt(Vector3, Vector3, double)

Change the camera to look at the specified point.

public void LookAt(Vector3 p, Vector3 direction, double animationTime)

Parameters

p Vector3

The point.

direction Vector3

The direction.

animationTime double

The animation time.

MeasureOverride(Size)

Measures the control and its child elements as part of a layout pass.

protected override Size MeasureOverride(Size constraint)

Parameters

constraint Size

Returns

Size

The desired size for the control.

OnApplyTemplate(TemplateAppliedEventArgs)

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

protected override void OnApplyTemplate(TemplateAppliedEventArgs e)

Parameters

e TemplateAppliedEventArgs

Exceptions

HelixToolkitException

{0} is missing from the template.

OnKeyDown(KeyEventArgs)

Called before the Avalonia.Input.InputElement.KeyDown event occurs.

protected override void OnKeyDown(KeyEventArgs e)

Parameters

e KeyEventArgs

The event args.

OnPointerMoved(PointerEventArgs)

Called before the Avalonia.Input.InputElement.PointerMoved event occurs.

protected override void OnPointerMoved(PointerEventArgs e)

Parameters

e PointerEventArgs

The event args.

OnPointerPressed(PointerPressedEventArgs)

Called before the Avalonia.Input.InputElement.PointerPressed event occurs.

protected override void OnPointerPressed(PointerPressedEventArgs e)

Parameters

e PointerPressedEventArgs

The event args.

OnPointerReleased(PointerReleasedEventArgs)

Called before the Avalonia.Input.InputElement.PointerReleased event occurs.

protected override void OnPointerReleased(PointerReleasedEventArgs e)

Parameters

e PointerReleasedEventArgs

The event args.

OnPointerWheelChanged(PointerWheelEventArgs)

Called before the Avalonia.Input.InputElement.PointerWheelChanged event occurs.

protected override void OnPointerWheelChanged(PointerWheelEventArgs e)

Parameters

e PointerWheelEventArgs

The event args.

RaiseCameraChangedEvent()

Raises the camera changed event.

protected virtual void RaiseCameraChangedEvent()

Reset()

Resets the view.

public void Reset()

SetView(Vector3, Vector3, Vector3, double)

Change the camera position and directions.

public void SetView(Vector3 newPosition, Vector3 newDirection, Vector3 newUpDirection, double animationTime)

Parameters

newPosition Vector3

The new camera position.

newDirection Vector3

The new camera look direction.

newUpDirection Vector3

The new camera up direction.

animationTime double

The animation time.

ShowTargetAdorner(Point)

Shows the target adorner.

public void ShowTargetAdorner(Point position)

Parameters

position Point

The position.

ShowZoomRectangle(Rect)

Shows the zoom rectangle.

public void ShowZoomRectangle(Rect rect)

Parameters

rect Rect

The zoom rectangle.

StartSpin(Vector2, Point, Vector3)

Starts spinning.

public void StartSpin(Vector2 speed, Point position, Vector3 aroundPoint)

Parameters

speed Vector2

The speed.

position Point

The position.

aroundPoint Vector3

The point to spin around.

StopSpin()

Stops the spinning.

public void StopSpin()

Update(TimeSpan) 

public void Update(TimeSpan timeStamp)

Parameters

timeStamp TimeSpan

ZoomExtents(BoundingBox, double)

Zooms to the extents of the specified bounding box.

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

Parameters

bounds BoundingBox

The bounding box.

animationTime double

The animation time.

ZoomExtents(double)

Zooms to the extents of the model.

public void ZoomExtents(double animationTime = 200)

Parameters

animationTime double

The animation time (milliseconds).

Events

CameraChanged

Event when a property has been changed

public event EventHandler<RoutedEventArgs> CameraChanged

Event Type

EventHandler<RoutedEventArgs>

MouseDown3D

Provide CLR accessors for the event

public event EventHandler<PointerPressedEventArgs> MouseDown3D

Event Type

EventHandler<PointerPressedEventArgs>

MouseMove3D

Provide CLR accessors for the event

public event EventHandler<PointerEventArgs> MouseMove3D

Event Type

EventHandler<PointerEventArgs>

MouseUp3D

Provide CLR accessors for the event

public event EventHandler<PointerPressedEventArgs> MouseUp3D

Event Type

EventHandler<PointerPressedEventArgs>

OnRendered

Occurs when each render frame finished rendering. Called directly from RenderHost after each frame. Use this event carefully. Unsubscrible this event when not used. Otherwise may cause performance issue.

public event EventHandler? OnRendered

Event Type

EventHandler

RenderExceptionOccurred

Fired whenever an exception occurred at rendering subsystem.

public event EventHandler<RelayExceptionEventArgs> RenderExceptionOccurred

Event Type

EventHandler<RelayExceptionEventArgs>
Edit this page