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

    Class MeasureLineGlobalSprite

    The sprite displaying the total length of a measure line

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    children clickCallback? distance isDisplayable isMeasureLineGlobalSprite isMeasureLineSprite isRaycastable isSceneObject isSceneSprite isSelectable isTransformable lastDistanceOrZoomCamera measureLine name parent signals sprite spriteScale spriteScaleDot transformConfig userData uuid

    Accessors

    active anchorIndex material overrideColor selected spriteType type visible

    Methods

    _computeColor _computeTexture addChild applyMatrix dispose getBoundingBox getBoundingSphere getMatrix getPosition getStateController getTexture parentsGenerator projectPointOnEdges raycast removeFromParent setMatrix setPosition setScale setTexture toJson updateDistance updateSpriteScale updateSpriteTypeWithCamera updateType

    Constructors

    Properties

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

    Indicates whether the object is selectable in the scene

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

    Unique identifier of the object

    Accessors

    • get active(): boolean

      Returns boolean

    • get anchorIndex(): number

      Returns number

    • get material(): SpriteMaterial

      Returns SpriteMaterial

    • set overrideColor(value: string | null): void

      Allow to override the default background color of the sprite

      Parameters

      • value: string | null

      Returns void

    • get selected(): boolean

      Returns boolean

    • set selected(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get spriteType(): SpriteType

      Returns SpriteType

    • get type(): string

      Returns string

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    Protected_computeColor

    • _computeColor(): { bgColor: string; lineColor: string; textColor: string }

      Returns { bgColor: string; lineColor: string; textColor: string }

    Protected_computeTexture

    • _computeTexture(recalculateTexture: boolean): void

      Parameters

      • recalculateTexture: boolean

      Returns void

    • Parameters

      • matrix: Matrix4

      Returns void

    • Returns void

    • Parameters

      • target: Box3

      Returns Box3

    • Parameters

      • target: Sphere

      Returns Sphere

    • Parameters

      • target: Matrix4

      Returns Matrix4

    • Parameters

      • target: Vector3

      Returns Vector3

    • Parameters

      • distance: number

      Returns CanvasTexture

    • 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

      • x: number
      • y: number
      • z: number

      Returns void

    • Parameters

      • texture: Texture

      Returns void

    • Returns Record<string, any>

    • Update the distance to display on the sprite

      Parameters

      • startPosition: Vector3
      • endPosition: Vector3

      Returns void

    • Update the scale of the sprite depending on the type of sprite

      Returns void

    • Update the scale and the type of sprite depending on the camera distance

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods