Class RegisteredGizmo

The RegisteredGizmo represents a gizmo that is currently registered with a gizmo manager.

Index

Constructors

Properties

_componentClass _gizmoClass _isEnabled _isGlobal _isInteractive

Accessors

componentClass gizmoClass isEnabled isGlobal isInteractive

Methods

assign clone isEqual isEqual

Constructors

constructor

new RegisteredGizmo(
    gizmoClass?: Type,
    componentClass?: Type,
    isEnabled?: boolean,
    isGlobal?: boolean,
    isInteractive?: boolean,
): RegisteredGizmo
Parameters
- OptionalgizmoClass: Type
- OptionalcomponentClass: Type
- OptionalisEnabled: boolean
- OptionalisGlobal: boolean
- OptionalisInteractive: boolean
Returns RegisteredGizmo

Properties

`Protected`_componentClass

_componentClass: Type

`Protected`_gizmoClass

_gizmoClass: Type

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_isGlobal

_isGlobal: boolean

`Protected`_isInteractive

_isInteractive: boolean

Accessors

componentClass

get componentClass(): Type

The component class that is affected by the gizmo.

Returns Type
set componentClass(value: Type): void
Parameters
- value: Type
Returns void

gizmoClass

get gizmoClass(): Type

The class that is instanced by the gizmo.

Returns Type

Note
The GizmoClass value is only available when the data represents a registered InteractiveGizmo.
set gizmoClass(value: Type): void
Parameters
- value: Type
Returns void

isEnabled

get isEnabled(): boolean

Determines if the gizmo is being instanced for the component or globally.

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

isGlobal

get isGlobal(): boolean

Determines if the gizmo is global.

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

isInteractive

get isInteractive(): boolean

Determines if the gizmo is interactive.

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

Methods

assign

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

clone

clone(): RegisteredGizmo

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

Returns RegisteredGizmo

isEqual

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

`Static`isEqual

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