Class GizmoDrawSettings

Settings that control gizmo drawing.

Index

Constructors

Properties

_iconScale _interactiveGizmoSize _lineWidth _nearFadeDistance

Accessors

iconScale interactiveGizmoSize lineWidth nearFadeDistance

Methods

assign clone isEqual isEqual

Constructors

constructor

new GizmoDrawSettings(
    interactiveGizmoSize?: number,
    iconScale?: number,
    nearFadeDistance?: number,
    lineWidth?: number,
): GizmoDrawSettings
Parameters
- OptionalinteractiveGizmoSize: number
- OptionaliconScale: number
- OptionalnearFadeDistance: number
- OptionallineWidth: number
Returns GizmoDrawSettings

Properties

`Protected`_iconScale

_iconScale: number

`Protected`_interactiveGizmoSize

_interactiveGizmoSize: number

`Protected`_lineWidth

_lineWidth: number

`Protected`_nearFadeDistance

_nearFadeDistance: number

Accessors

iconScale

get iconScale(): number

Scale to apply to gizmo icons, controlling their size.

Returns number
set iconScale(value: number): void
Parameters
- value: number
Returns void

interactiveGizmoSize

get interactiveGizmoSize(): number

Scale to apply to interactive gizmo intersection shapes.

Returns number
set interactiveGizmoSize(value: number): void
Parameters
- value: number
Returns void

lineWidth

get lineWidth(): number

The width of gizmo lines.

Returns number
set lineWidth(value: number): void
Parameters
- value: number
Returns void

nearFadeDistance

get nearFadeDistance(): number

Near distance at which gizmos start fading out.

Returns number
set nearFadeDistance(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<GizmoDrawSettings>): GizmoDrawSettings
Copies all properties defined by the prototype of GizmoDrawSettings from other to this instance.
Parameters
- other: Immutable<GizmoDrawSettings>
Returns GizmoDrawSettings

clone

clone(): GizmoDrawSettings

Clones this instance and returns a new GizmoDrawSettings with identical values.

Returns GizmoDrawSettings

isEqual

isEqual(
this: Immutable<GizmoDrawSettings>,
other: Immutable<GizmoDrawSettings>,
): boolean
Determines if this GizmoDrawSettings instance is equal to the other instance.
Parameters
- this: Immutable<GizmoDrawSettings>
- other: Immutable<GizmoDrawSettings>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<GizmoDrawSettings>,
rhs: Immutable<GizmoDrawSettings>,
): boolean
Determines if both GizmoDrawSettings instances are equal.
Parameters
- lhs: Immutable<GizmoDrawSettings>
- rhs: Immutable<GizmoDrawSettings>
Returns boolean