Class ViewportCore

Namespace

HelixToolkit.SharpDX

Assembly

HelixToolkit.SharpDX.dll

public class ViewportCore : DisposeObject, IViewport3DX, IDisposable

Inheritance

object

DisposeObject

ViewportCore

Implements

IViewport3DX

IDisposable

Inherited Members

DisposeObject.RemoveAndDispose<T>(ref T)

DisposeObject.RemoveAndDispose<T>(T)

DisposeObject.RefCount

DisposeObject.IncRef()

DisposeObject.ForceDispose()

DisposeObject.IsDisposed

DisposeObject.Dispose()

DisposeObject.Set<T>(ref T, T)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IViewportExtensions.FindBounds(IViewport3DX)

IViewportExtensions.FindBoundsInternal(IViewport3DX)

IViewportExtensions.FindHits(IViewport3DX, Vector2)

IViewportExtensions.FindHits(IViewport3DX, Vector2, ref List<HitTestResult>)

IViewportExtensions.FindHitsInFrustum(IViewport3DX, Vector2, ref List<HitTestResult>)

IViewportExtensions.FindNearest(IViewport3DX, Vector2, out Vector3, out Vector3, out object?)

IViewportExtensions.ForceUpdateTransformsAndBounds(IViewport3DX)

IViewportExtensions.GetProjectionMatrix(IViewport3DX)

IViewportExtensions.GetScreenViewProjectionMatrix(IViewport3DX)

IViewportExtensions.GetViewProjectionMatrix(IViewport3DX)

IViewportExtensions.GetViewportMatrix(IViewport3DX)

IViewportExtensions.Project(IViewport3DX, Vector3)

IViewportExtensions.RenderToBitmapStream(IViewport3DX)

IViewportExtensions.Traverse(IViewport3DX, Action<SceneNode>)

IViewportExtensions.Traverse(IViewport3DX, Func<SceneNode, bool>)

IViewportExtensions.UnProject(IViewport3DX, Vector2, out Ray)

IViewportExtensions.UnProjectOnPlane(IViewport3DX, Vector2, Vector3, Vector3)

IViewportExtensions.UnProjectOnPlane(IViewport3DX, Vector2, Vector3, Vector3, out Vector3)

Constructors

ViewportCore()

Initializes a new instance of the ViewportCore class.

public ViewportCore()

ViewportCore(IRenderHost)

Initializes a new instance of the ViewportCore class.

public ViewportCore(IRenderHost renderHost)

Parameters

renderHost IRenderHost

ViewportCore(nint, bool)

Initializes a new instance of the ViewportCore class.

public ViewportCore(nint nativeWindowPointer, bool deferred = false)

Parameters

nativeWindowPointer nint

The native window pointer.

deferred bool

if set to true [deferred].

Properties

ActualHeight

Gets the actual height.

public double ActualHeight { get; }

Property Value

double

The actual height.

ActualWidth

Gets the actual width.

public double ActualWidth { get; }

Property Value

double

The actual width.

BackgroundColor

Gets or sets the color of the background.

public Color4 BackgroundColor { get; set; }

Property Value

Color4

The color of the background.

CameraCore

Gets the camera core.

public CameraCore? CameraCore { get; set; }

Property Value

CameraCore

The camera core.

CoordinateSystemAxisXLabel

Gets or sets the coordinate system axis x label.

public string CoordinateSystemAxisXLabel { get; set; }

Property Value

string

The coordinate system axis x label.

CoordinateSystemAxisYLabel

Gets or sets the coordinate system axis y label.

public string CoordinateSystemAxisYLabel { get; set; }

Property Value

string

The coordinate system axis y label.

CoordinateSystemAxisZLabel

Gets or sets the coordinate system axis z label.

public string CoordinateSystemAxisZLabel { get; set; }

Property Value

string

The coordinate system axis z label.

CoordinateSystemLabelColor

Gets or sets the color of the coordinate system label.

public Color4 CoordinateSystemLabelColor { get; set; }

Property Value

Color4

The color of the coordinate system label.

D2DRenderables

Gets the d2 d renderables.

public IEnumerable<SceneNode2D> D2DRenderables { get; }

Property Value

IEnumerable<SceneNode2D>

The d2 d renderables.

DpiScale

public double DpiScale { get; set; }

Property Value

double

EffectsManager

Gets or sets the effects manager.

public IEffectsManager? EffectsManager { get; set; }

Property Value

IEffectsManager

The effects manager.

EnableOITDepthPeelingDynamicIteration

public bool EnableOITDepthPeelingDynamicIteration { get; set; }

Property Value

bool

EnableRenderFrustum

Gets or sets a value indicating whether [enable render frustum].

public bool EnableRenderFrustum { get; set; }

Property Value

bool

true if [enable render frustum]; otherwise, false.

EnableRenderOrder

Gets or sets a value indicating whether [enable render order].

public bool EnableRenderOrder { get; set; }

Property Value

bool

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

EnableSSAO

Gets or sets a value indicating whether [enable ssao].

public bool EnableSSAO { get; set; }

Property Value

bool

true if [enable ssao]; otherwise, false.

EnableVSync

Gets or sets a value indicating whether [enable vertical synchronize].

public bool EnableVSync { get; set; }

Property Value

bool

true if [enable vertical synchronize]; otherwise, false.

FXAALevel

Gets or sets the FXAA level.

public FXAALevel FXAALevel { get; set; }

Property Value

FXAALevel

The FXAA level.

IsShadowMappingEnabled

Gets a value indicating whether this instance is shadow mapping enabled.

public bool IsShadowMappingEnabled { get; set; }

Property Value

bool

true if this instance is shadow mapping enabled; otherwise, false.

Items

Gets the items.

public GroupNode Items { get; }

Property Value

GroupNode

The items.

Items2D

Gets the items2 d.

public SceneNode2D Items2D { get; }

Property Value

SceneNode2D

The items2 d.

ModelUpDirection

Gets or sets the model up direction.

public Vector3 ModelUpDirection { get; set; }

Property Value

Vector3

The model up direction.

OITDepthPeelingIteration

public int OITDepthPeelingIteration { get; set; }

Property Value

int

OITRenderType

Gets or sets the order independent transparency render type.

public OITRenderType OITRenderType { get; set; }

Property Value

OITRenderType

RenderConfiguration

Gets the render configuration.

public DX11RenderHostConfiguration RenderConfiguration { get; }

Property Value

DX11RenderHostConfiguration

RenderContext

Gets the render context.

public RenderContext? RenderContext { get; }

Property Value

RenderContext

The render context.

RenderD2D

Gets or sets a value indicating whether [render d2d].

public bool RenderD2D { get; set; }

Property Value

bool

true if [render d2d]; otherwise, false.

RenderHost

Gets the render host.

public IRenderHost RenderHost { get; }

Property Value

IRenderHost

The render host.

RenderStat

Gets the render stat.

public IRenderStatistics? RenderStat { get; }

Property Value

IRenderStatistics

The render stat.

Renderables

Gets the renderables.

public IEnumerable<SceneNode> Renderables { get; }

Property Value

IEnumerable<SceneNode>

The renderables.

ShowCoordinateSystem

Gets or sets a value indicating whether [show coordinate system].

public bool ShowCoordinateSystem { get; set; }

Property Value

bool

true if [show coordinate system]; otherwise, false.

ShowFPS

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

public bool ShowFPS { get; set; }

Property Value

bool

true if [show FPS]; otherwise, false.

ShowRenderDetail

Gets or sets a value indicating whether [show render detail].

public bool ShowRenderDetail { get; set; }

Property Value

bool

true if [show render detail]; otherwise, false.

ShowViewCube

Gets or sets a value indicating whether [show view cube].

public bool ShowViewCube { get; set; }

Property Value

bool

true if [show view cube]; otherwise, false.

ViewportRectangle

Gets the viewport rectangle.

public Rectangle ViewportRectangle { get; }

Property Value

Rectangle

The viewport rectangle.

Methods

Attach(IRenderHost)

Attaches the specified host.

public void Attach(IRenderHost host)

Parameters

host IRenderHost

The host.

Detach()

Detaches this instance.

public void Detach()

EndD3D()

Ends the d3 d.

public void EndD3D()

InvalidateRender()

Invalidates the render.

public void InvalidateRender()

InvalidateSceneGraph()

Invalidates the scene graph.

public void InvalidateSceneGraph()

MouseDown(Vector2)

Mouses down.

public void MouseDown(Vector2 position)

Parameters

position Vector2

The position.

MouseMove(Vector2)

Mouses the move.

public void MouseMove(Vector2 position)

Parameters

position Vector2

The position.

MouseUp(Vector2)

Mouses up.

public void MouseUp(Vector2 position)

Parameters

position Vector2

The position.

OnDispose(bool)

Disposes of object resources.

protected override void OnDispose(bool disposeManagedResources)

Parameters

disposeManagedResources bool

If true, managed resources should be disposed of in addition to unmanaged resources.

Render()

Renders this instance.

public void Render()

Resize(int, int)

Resizes the specified width.

public void Resize(int width, int height)

Parameters

width int

The width.

height int

The height.

StartD3D(int, int)

Starts the d3 d.

public void StartD3D(int width, int height)

Parameters

width int

The width.

height int

The height.

Update(TimeSpan)

public void Update(TimeSpan timeStamp)

Parameters

timeStamp TimeSpan

Events

ErrorOccurred

Occurs when [on error occurred].

public event EventHandler<Exception>? ErrorOccurred

Event Type

EventHandler<Exception>

NodeHitOnMouseDown

public event EventHandler<SceneNodeMouseDownArgs>? NodeHitOnMouseDown

Event Type

EventHandler<SceneNodeMouseDownArgs>

NodeHitOnMouseMove

public event EventHandler<SceneNodeMouseMoveArgs>? NodeHitOnMouseMove

Event Type

EventHandler<SceneNodeMouseMoveArgs>

NodeHitOnMouseUp

public event EventHandler<SceneNodeMouseUpArgs>? NodeHitOnMouseUp

Event Type

EventHandler<SceneNodeMouseUpArgs>

StartRendering

Occurs when [on start rendering].

public event EventHandler? StartRendering

Event Type

EventHandler

StopRendering

Occurs when [on stop rendering].

public event EventHandler? StopRendering

Event Type

EventHandler