Documentation - v19.2.0-dev
    Preparing search index...

    Class SceneSprite

    Base class for scene objects that are raycastable

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    children clickCallback? isDisplayable isRaycastable isSceneObject isSceneSprite isSelectable isTransformable name parent signals sprite transformConfig userData uuid

    Accessors

    active material selected type visible

    Methods

    addChild applyMatrix dispose getBoundingBox getBoundingSphere getMatrix getPosition getStateController parentsGenerator projectPointOnEdges raycast removeFromParent setMatrix setPosition setTexture toJson

    Constructors

    Properties

    children: SceneObject[] = ...
    clickCallback?: () => void
    isDisplayable: true
    isRaycastable: boolean = true
    isSceneObject: true
    isSceneSprite: true
    isSelectable: boolean = true

    Indicates whether the object is selectable in the scene

    isTransformable: boolean = true
    name: string = ''
    parent: SceneObject | null = null
    signals: {
        onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
        onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
    } = ...
    sprite: Sprite
    transformConfig: ObjectTransformConfig = ...
    userData: Record<string, any> = {}
    uuid: string

    Unique identifier of the object

    Accessors

    • get active(): boolean

      Returns boolean

    • get material(): SpriteMaterial

      Returns SpriteMaterial

    • get selected(): boolean

      Returns boolean

    • set selected(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get type(): string

      Returns string

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Parameters

      • matrix: Matrix4

      Returns void

    • Parameters

      • target: Box3

      Returns Box3

    • Parameters

      • target: Sphere

      Returns Sphere

    • Parameters

      • target: Matrix4

      Returns Matrix4

    • Parameters

      • target: Vector3

      Returns Vector3

    • Parameters

      • point: Vector3
      • target: Vector3
      • maxEdgeDistance: number

      Returns boolean

    • Performs raycasting on the mesh.

      Parameters

      • raycaster: Raycaster

        The raycaster to use

      • intersections: SceneIntersection[]

        The array of resulting intersections

      Returns void

    • Parameters

      • matrix: Matrix4

      Returns Matrix4

    • Parameters

      • position: Vector3

      Returns Vector3

    • Parameters

      • texture: Texture

      Returns void

    • Returns Record<string, any>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods