Class ScenePickInformation

The ScenePickInformation struct holds the object that the pointer is snapping to and its snap data

Index

Constructors

Properties

_component _sceneObject _snapData

Accessors

component sceneObject snapData

Methods

assign clone isEqual isEqual

Constructors

constructor

new ScenePickInformation(sceneObject?, component?, snapData?): ScenePickInformation
Parameters
- OptionalsceneObject: SceneObject
- Optionalcomponent: Component
- OptionalsnapData: SnapData
Returns ScenePickInformation

Properties

`Protected`_component

_component: Component

`Protected`_sceneObject

_sceneObject: SceneObject

`Protected`_snapData

_snapData: SnapData

Accessors

component

get component(): Component
The picked Component.

Returns Component
set component(value): void
Parameters
- value: Component
Returns void

sceneObject

get sceneObject(): SceneObject
The picked SceneObject.

Returns SceneObject
set sceneObject(value): void
Parameters
- value: SceneObject
Returns void

snapData

get snapData(): SnapData
SnapData for the point on object surface that was hit.

Returns SnapData
set snapData(value): void
Parameters
- value: SnapData
Returns void

Methods

assign

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

clone

clone(): ScenePickInformation
Clones this instance and returns a new ScenePickInformation with identical values.

Returns ScenePickInformation

isEqual

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

`Static`isEqual

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