Class ScenePickInformation

The ScenePickInformation represents information about a scene picking operation such as the picked object, component, and spatial information. Additionally, SnapData can be generate to provide more detailed information about the specific part of the object that was picked.

See

ScenePicking

Index

Constructors

constructor

new ScenePickInformation(
    sceneObject?: SceneObject,
    component?: Component,
    mesh?: Mesh,
    meshLODGroupIndex?: number,
    subMesh?: Immutable<SubMesh>,
    subMeshIndex?: number,
    material?: Material,
    snapData?: SnapData,
    normal?: Immutable<Vector3>,
    position?: Immutable<Vector3>,
    cursorPosition?: Immutable<rsx.UIPixel>,
): ScenePickInformation
Parameters
- OptionalsceneObject: SceneObject
- Optionalcomponent: Component
- Optionalmesh: Mesh
- OptionalmeshLODGroupIndex: number
- OptionalsubMesh: Immutable<SubMesh>
- OptionalsubMeshIndex: number
- Optionalmaterial: Material
- OptionalsnapData: SnapData
- Optionalnormal: Immutable<Vector3>
- Optionalposition: Immutable<Vector3>
- OptionalcursorPosition: Immutable<rsx.UIPixel>
Returns ScenePickInformation

Inherited from ScenePickInformationGenerated.constructor

Properties

`Protected`_component

_component: Component

`Protected`_cursorPosition

_cursorPosition: Vector2

`Protected`_material

_material: Material

`Protected`_mesh

_mesh: Mesh

`Protected`_meshLODGroupIndex

_meshLODGroupIndex: number

`Protected`_normal

_normal: Vector3

`Protected`_position

_position: Vector3

`Protected`_sceneObject

_sceneObject: SceneObject

`Protected`_snapData

_snapData: SnapData

`Protected` `Optional`_subMesh

_subMesh?: SubMesh

`Protected` `Optional`_subMeshIndex

_subMeshIndex?: number

Accessors

component

get component(): Component

The picked Component.

Returns Component

Inherited from ScenePickInformationGenerated.component
set component(value: Component): void
Parameters
- value: Component
Returns void

Inherited from ScenePickInformationGenerated.component

cursorPosition

get cursorPosition(): Vector2

The cursor position in screen space of the render target when the pick occurred.

Returns Vector2

Inherited from ScenePickInformationGenerated.cursorPosition
set cursorPosition(value: Immutable<rsx.UIPixel>): void
Parameters
- value: Immutable<rsx.UIPixel>
Returns void

Inherited from ScenePickInformationGenerated.cursorPosition

material

get material(): Material

The material assigned to the picked SubMesh, if available.

Returns Material

Inherited from ScenePickInformationGenerated.material
set material(value: Material): void
Parameters
- value: Material
Returns void

Inherited from ScenePickInformationGenerated.material

mesh

get mesh(): Mesh

The picked Mesh, if available.

Returns Mesh

Inherited from ScenePickInformationGenerated.mesh
set mesh(value: Mesh): void
Parameters
- value: Mesh
Returns void

Inherited from ScenePickInformationGenerated.mesh

meshLODGroupIndex

get meshLODGroupIndex(): number

The LOD group index of the picked mesh.

Returns number

Inherited from ScenePickInformationGenerated.meshLODGroupIndex
set meshLODGroupIndex(value: number): void
Parameters
- value: number
Returns void

Inherited from ScenePickInformationGenerated.meshLODGroupIndex

normal

get normal(): Vector3

The normal of the surface at the picked point.

Returns Vector3

Inherited from ScenePickInformationGenerated.normal
set normal(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

Inherited from ScenePickInformationGenerated.normal

position

get position(): Vector3

The world position of the picked point.

Returns Vector3

Inherited from ScenePickInformationGenerated.position
set position(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

Inherited from ScenePickInformationGenerated.position

sceneObject

get sceneObject(): SceneObject

The picked SceneObject.

Returns SceneObject

Inherited from ScenePickInformationGenerated.sceneObject
set sceneObject(value: SceneObject): void
Parameters
- value: SceneObject
Returns void

Inherited from ScenePickInformationGenerated.sceneObject

snapData

get snapData(): SnapData

SnapData for the point on object surface that was hit.

Returns SnapData

Inherited from ScenePickInformationGenerated.snapData
set snapData(value: SnapData): void
Parameters
- value: SnapData
Returns void

Inherited from ScenePickInformationGenerated.snapData

subMesh

get subMesh(): SubMesh

The picked SubMesh, if available.

Returns SubMesh

Inherited from ScenePickInformationGenerated.subMesh
set subMesh(value: Immutable<SubMesh>): void
Parameters
- value: Immutable<SubMesh>
Returns void

Inherited from ScenePickInformationGenerated.subMesh

subMeshIndex

get subMeshIndex(): number

The index of the picked SubMesh, if available.

Returns number

Inherited from ScenePickInformationGenerated.subMeshIndex
set subMeshIndex(value: number): void
Parameters
- value: number
Returns void

Inherited from ScenePickInformationGenerated.subMeshIndex

Methods

assign

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

Inherited from ScenePickInformationGenerated.assign

clone

clone(): ScenePickInformation

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

Returns ScenePickInformation

Inherited from ScenePickInformationGenerated.clone

isEqual

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

Inherited from ScenePickInformationGenerated.isEqual

`Static`isEqual

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

Inherited from ScenePickInformationGenerated.isEqual

Class ScenePickInformation

See

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScenePickInformation

Properties

Protected_component

Protected_cursorPosition

Protected_material

Protected_mesh

Protected_meshLODGroupIndex

Protected_normal

Protected_position

Protected_sceneObject

Protected_snapData

Protected Optional_subMesh

Protected Optional_subMeshIndex

Accessors

component

Returns Component

Parameters

Returns void

cursorPosition

Returns Vector2

Parameters

Returns void

material

Returns Material

Parameters

Returns void

mesh

Returns Mesh

Parameters

Returns void

meshLODGroupIndex

Returns number

Parameters

Returns void

normal

Returns Vector3

Parameters

Returns void

position

Returns Vector3

Parameters

Returns void

sceneObject

Returns SceneObject

Parameters

Returns void

snapData

Returns SnapData

Parameters

Returns void

subMesh

Returns SubMesh

Parameters

Returns void

subMeshIndex

Returns number

Parameters

Returns void

Methods

assign

Parameters

Returns ScenePickInformation

clone

Returns ScenePickInformation

isEqual

Parameters

Returns boolean

StaticisEqual

Parameters

Returns boolean

`Protected`_component

`Protected`_cursorPosition

`Protected`_material

`Protected`_mesh

`Protected`_meshLODGroupIndex

`Protected`_normal

`Protected`_position

`Protected`_sceneObject

`Protected`_snapData

`Protected` `Optional`_subMesh

`Protected` `Optional`_subMeshIndex

`Static`isEqual