Table of Contents

Class AxisPlaneGridCore

Namespace
HelixToolkit.SharpDX.Core
Assembly
HelixToolkit.SharpDX.dll
public class AxisPlaneGridCore : RenderCore, IDisposable, IGUID, IThrowingShadow
Inheritance
AxisPlaneGridCore
Implements
Inherited Members

Constructors

AxisPlaneGridCore()

Initializes a new instance of the AxisPlaneGridCore class.

public AxisPlaneGridCore()

Properties

AcutalSpacing

Gets the acutal spacing.

public float AcutalSpacing { get; }

Property Value

float

The acutal spacing.

AutoSpacing

Gets or sets a value indicating whether [automatic spacing].

public bool AutoSpacing { get; set; }

Property Value

bool

true if [automatic spacing]; otherwise, false.

AutoSpacingRate

Gets or sets the automatic spacing rate. Default is 5 for perspective camera. If using orthographic camera, increase the rate value to for example > 15.

public float AutoSpacingRate { get; set; }

Property Value

float

The automatic spacing rate.

FadingFactor

Gets or sets the fading factor.

public float FadingFactor { get; set; }

Property Value

float

The fading factor.

GridColor

Gets or sets the color of the grid.

public Color4 GridColor { get; set; }

Property Value

Color4

The color of the grid.

GridPattern

Gets or sets the grid pattern.

public GridPattern GridPattern { get; set; }

Property Value

GridPattern

The grid pattern.

GridSpacing

Gets or sets the grid spacing.

public float GridSpacing { get; set; }

Property Value

float

The grid spacing.

GridThickness

Gets or sets the grid thickness.

public float GridThickness { get; set; }

Property Value

float

The grid thickness.

Offset

Gets or sets the axis plane offset.

public float Offset { get; set; }

Property Value

float

The offset.

PlaneColor

Gets or sets the color of the plane.

public Color4 PlaneColor { get; set; }

Property Value

Color4

The color of the plane.

RenderShadowMap

Gets or sets a value indicating whether [render shadow map].

public bool RenderShadowMap { get; set; }

Property Value

bool

true if [render shadow map]; otherwise, false.

UpAxis

Gets or sets Up Axis. Default is Y

public Axis UpAxis { get; set; }

Property Value

Axis

The plane.

Methods

OnAttach(IRenderTechnique?)

During attatching render core. Create all local resources. Use Collect(resource) to let object be released automatically during Detach().

protected override bool OnAttach(IRenderTechnique? technique)

Parameters

technique IRenderTechnique

Returns

bool

OnDetach()

On detaching, default is to release all resources

protected override void OnDetach()

Render(RenderContext, DeviceContextProxy)

Render routine

public override void Render(RenderContext context, DeviceContextProxy deviceContext)

Parameters

context RenderContext
deviceContext DeviceContextProxy