Class InteractorLineVisual

InteractorLineVisual uses a modified line renderer to display the ray interactor visual Uses interactor locus and direction

Hierarchy (view full)

BaseScriptComponent
- InteractorLineVisual

Index

Constructors

constructor

new InteractorLineVisual(): InteractorLineVisual
Returns InteractorLineVisual
Inherited from BaseScriptComponent.constructor

Properties

_beginColor

_beginColor: vec3 = ...

_endColor

_endColor: vec3 = ...

`Optional`_interactor

_interactor?: default

api

api: Record<string, any>

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

lineStyle

lineStyle: number = 2

name

name: string

`Readonly`sceneObject

sceneObject: SceneObject

`Readonly`uniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

Accessors

beginColor

get beginColor(): vec3
Gets the color of the visual from the start.

Returns vec3
set beginColor(color): void
Sets the color of the visual from the start.
Parameters
- color: vec3
Returns void

endColor

get endColor(): vec3
Gets the color of the visual from the end.

Returns vec3
set endColor(color): void
Sets the color of the visual from the end.
Parameters
- color: vec3
Returns void

isEnabled

get isEnabled(): boolean
Gets whether the visual is active (can be shown if hand is in frame and we're in far field targeting mode).

Returns boolean
set isEnabled(isEnabled): void
Sets whether the visual can be shown, so developers can show/hide the ray in certain parts of their lens.
Parameters
- isEnabled: boolean
Returns void

visualStyle

get visualStyle(): VisualStyle
Gets the current visual style.

Returns VisualStyle
set visualStyle(style): void
Sets how the visuals for the line drawer should be shown.
Parameters
- style: VisualStyle
Returns void

Methods

createEvent

createEvent<K>(eventType): EventNameMap[K]
Adds a new SceneEvent, triggered by eventType events, to the ScriptComponent.
Type Parameters
- K extends keyof EventNameMap
Parameters
- eventType: K
Returns EventNameMap[K]
Inherited from BaseScriptComponent.createEvent

destroy

destroy(): void
Destroys the component.

Returns void
Inherited from BaseScriptComponent.destroy

getReferencedEvents

getReferencedEvents(): SceneEvent[]
Returns SceneEvent[]
Inherited from BaseScriptComponent.getReferencedEvents

getSceneObject

getSceneObject(): SceneObject
Returns the SceneObject the component is attached to.

Returns SceneObject
Inherited from BaseScriptComponent.getSceneObject

getTransform

getTransform(): Transform
Returns the Transform this component is attached to.

Returns Transform
Inherited from BaseScriptComponent.getTransform

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from BaseScriptComponent.getTypeName

isOfType

isOfType(type): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from BaseScriptComponent.isOfType

isSame

isSame(other): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from BaseScriptComponent.isSame

onAwake

onAwake(): void
Returns void

onDestroy

onDestroy(): void
Destroys cursor & line renderer when the custom component is destroyed.

Returns void

removeEvent

removeEvent(event): void
Removes a previously added SceneEvent from the ScriptComponent.
Parameters
- event: SceneEvent
Returns void
Inherited from BaseScriptComponent.removeEvent

update

update(): void
Updates the line visual each frame

Returns void

`Static`getTypeName

getTypeName<T>(this): TypeName<InstanceType<T>>
Type Parameters
- T extends typeof BaseScriptComponent
Parameters
- this: T
Returns TypeName<InstanceType<T>>
Inherited from BaseScriptComponent.getTypeName