DecoratorCoordinateAxes

Description

sealed class Tinman.AddOns.Widgets.DecoratorCoordinateAxes

Derived from

ModelDecorator abstract

Full source code is included in the Tinman 3D SDK download.

A IModelDecorator that builds lines for the coordinate axes.

In addition to building a decoration model, the RenderOverlay method can be used to draw a 2D overlay for labelling the coordinate axes.

Public / Constructors

Decorator​Coordinate​Axes

public constructor DecoratorCoordinateAxes → ()

Creates a new instance of DecoratorCoordinateAxes.

Public / Methods

Pad

[Pure]
public static method Pad → (2)

box in : Box3D

The bounding box.

padScale opt : float64 = 1

The pad scale factor, PadScale

returns → float64

The padding amount, see Box3D.Pad.

Computes the amount of padding that is applied to the coordinate axes.

Render​Overlay

public method RenderOverlay → (3)

graphics in : Graphics

[not-null]
The Graphics object to uise.

model in : IModel

[not-null]
The IModel object.

viewport in : ICameraViewportDepth

[not-null]
The camera viewport.

Draws a 2D overlay for labelling the coordinate axes.

See also

DecoratorCoordinateAxes.ColorX
DecoratorCoordinateAxes.ColorY
DecoratorCoordinateAxes.ColorZ
DecoratorCoordinateAxes.FontLabel
DecoratorCoordinateAxes.FontMetrics

Public / Attributes

Color​X

public attribute ColorX → (get,set)

value : int64

The axis color.

The color for the X-axis.

Defaults to Colors.Red.

See also

Colors

Color​Y

public attribute ColorY → (get,set)

value : int64

The axis color.

The color for the Y-axis.

Defaults to Colors.Green.

See also

Colors

Color​Z

public attribute ColorZ → (get,set)

value : int64

The axis color.

The color for the Z-axis.

Defaults to Colors.Blue.

See also

Colors

Font​Label

public attribute FontLabel → (get,set)

value : IResourceHandle

The pixel font handle or null to hide the labels.

The font to use for drawing the axis labels.

See also

DecoratorCoordinateAxes.RenderOverlay

Font​Metrics

public attribute FontMetrics → (get,set)

value : IResourceHandle

The pixel font handle or null to hide the metrics.

The font to use for drawing the axis metrics.

See also

DecoratorCoordinateAxes.RenderOverlay

Line​Thickness

public attribute LineThickness → (get,set)

value : float32

[>=1]
The line thickness.

The line thickness.

Defaults to 1.5f.

Pad​Scale

public attribute PadScale → (get,set)

value : float64

The pad scale factor.

The scale factor for the pad amount of the axis lines, with respect to the bounding box.

Defaults to 1.

See also

DecoratorCoordinateAxes.Pad