Class InteractiveGizmoSliderBase`Abstract`

Base class for all interactive slider gizmos. A interactive slider gizmo is geometry that the user can interact with by selecting or dragging (sliding) it. Sliders generally output a one- or multi-dimensional delta value that signals the drag amount (and/or direction).

Hierarchy (View Summary)

InteractiveGizmoSliderBase

Index

Constructors

`Protected`constructor

new InteractiveGizmoSliderBase(
isInternalConstructor?: boolean,
): InteractiveGizmoSliderBase
Parameters
- OptionalisInternalConstructor: boolean
Returns InteractiveGizmoSliderBase

Overrides FrameworkObject.constructor

Accessors

colliders

get colliders(): Iterable<InteractiveGizmoColliderBase>

The colliders that are used for intersection testing.

Returns Iterable<InteractiveGizmoColliderBase>
set colliders(
    value:
        | Iterable<InteractiveGizmoColliderBase>
        | readonly InteractiveGizmoColliderBase[],
): void
Parameters
- value: Iterable<InteractiveGizmoColliderBase> | readonly InteractiveGizmoColliderBase[]
Returns void

color

get color(): Immutable<Color>

The color of the slider.

Returns Immutable<Color>

Note
This is only relevant if CustomDrawing is enabled and the default slider representation is drawn.
set color(value: Immutable<Color>): void
Parameters
- value: Immutable<Color>
Returns void

isCustomDrawingEnabled

get isCustomDrawingEnabled(): boolean

Determines if custom drawing is enabled. This allows the user to draw custom gizmos for the slider in the Draw method of the parent InteractiveGizmo. If custom drawing is enabled, the built in visual representation for the slider will not be drawn.

Returns boolean
set isCustomDrawingEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isDragOnly

get isDragOnly(): boolean

Whether this slider only activates on drag, allowing click events to pass through to other systems.

Returns boolean
set isDragOnly(value: boolean): void
Parameters
- value: boolean
Returns void

isDrawingWireframe

get isDrawingWireframe(): boolean

Determines if the slider is being drawn as wireframe mesh instead of solid.

Returns boolean

Note
This is only relevant if CustomDrawing is enabled and the default slider representation is drawn.
set isDrawingWireframe(value: boolean): void
Parameters
- value: boolean
Returns void

isEnabled

get isEnabled(): boolean

Enables or disables the slider, making it interactable or not.

Returns boolean
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isFixedScale

get isFixedScale(): boolean

Returns if fixed scale is enabled. If enabled the interactive gizmo will always try to maintain the same visible area in the viewport regardless of distance from camera.

Returns boolean

layer

get layer(): rsx.LayerMask

Returns a layer that determines which sliders are interacted with from a specific camera.

Returns rsx.LayerMask

position

get position(): Immutable<Vector3>

Sets the world position of the slider.

Returns Immutable<Vector3>
set position(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

priority

get priority(): number

The selection priority of this slider. Higher values beat lower when multiple sliders are under the cursor.

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

rotation

get rotation(): Immutable<Quaternion>

Sets the world rotation of the slider.

Returns Immutable<Quaternion>
set rotation(value: Immutable<Quaternion>): void
Parameters
- value: Immutable<Quaternion>
Returns void

scale

get scale(): Immutable<Vector3>

Sets the scale of the slider.

Returns Immutable<Vector3>
set scale(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

state

get state(): EnumValue<SliderGizmoState>

Returns the state the slider is currently in.

Returns EnumValue<SliderGizmoState>

transform

get transform(): Immutable<Transform>

Sets the full transform of the slider (position, rotation, scale, and skew).

Returns Immutable<Transform>
set transform(value: Immutable<Transform>): void
Parameters
- value: Immutable<Transform>
Returns void

Methods

remove

remove(): void

Removes this slider from its parent gizmo.

Returns void

Class InteractiveGizmoSliderBaseAbstract

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns InteractiveGizmoSliderBase

Accessors

colliders

Returns Iterable<InteractiveGizmoColliderBase>

Parameters

Returns void

color

Returns Immutable<Color>

Note

Parameters

Returns void

isCustomDrawingEnabled

Returns boolean

Parameters

Returns void

isDragOnly

Returns boolean

Parameters

Returns void

isDrawingWireframe

Returns boolean

Note

Parameters

Returns void

isEnabled

Returns boolean

Parameters

Returns void

isFixedScale

Returns boolean

layer

Returns rsx.LayerMask

position

Returns Immutable<Vector3>

Parameters

Returns void

priority

Returns number

Parameters

Returns void

rotation

Returns Immutable<Quaternion>

Parameters

Returns void

scale

Returns Immutable<Vector3>

Parameters

Returns void

state

Returns EnumValue<SliderGizmoState>

transform

Returns Immutable<Transform>

Parameters

Returns void

Methods

remove

Returns void

Settings

On This Page

Class InteractiveGizmoSliderBase`Abstract`

`Protected`constructor