Class CircleMesh

Hierarchy (view full)

Constructors

constructor

Properties

meshBackground meshFont name needsRender

Accessors

center color geometry normal occlusionMode occlusionVisibility opacity radius style

Methods

add addIfNotExists highlight remove removeChildren removeFromParent setPoints setStyle unhighlight

Constructors

constructor

  • new CircleMesh(params?): CircleMesh

  • Parameters

    • Optionalparams: Partial<OpacityStyle & ColorStyle & OcclusionStyle & CircleData>

    Returns CircleMesh

Properties

meshBackground

meshBackground: Mesh<Geometry | BufferGeometry, MeshBasicMaterial>

meshFont

meshFont: Mesh<CircleGeometry, MeshBasicMaterial>

name

name: string = 'ColoredMesh'

needsRender

needsRender: boolean

Accessors

center

  • get center(): Vector3

  • Returns Vector3

color

  • get color(): Color

  • Returns Color

geometry

  • get geometry(): TGeometry

  • Returns TGeometry

  • set geometry(geometry): void

  • Parameters

    • geometry: TGeometry

    Returns void

normal

  • get normal(): Vector3

  • Returns Vector3

  • set normal(n): void

  • Parameters

    • n: Vector3

    Returns void

occlusionMode

  • get occlusionMode(): "translucence" | "depthTest"

  • Returns "translucence" | "depthTest"

occlusionVisibility

  • get occlusionVisibility(): boolean

  • Returns boolean

opacity

  • get opacity(): number

  • Returns number

radius

  • get radius(): number

  • Returns number

style

  • get style(): {
        color: Color;
        occlusionMode: "translucence" | "depthTest";
        occlusionVisibility: boolean;
        opacity: number;
    }

  • Returns {
        color: Color;
        occlusionMode: "translucence" | "depthTest";
        occlusionVisibility: boolean;
        opacity: number;
    }

    • color: Color
    • occlusionMode: "translucence" | "depthTest"
    • occlusionVisibility: boolean
    • opacity: number

Methods

add

  • add(...objects): CircleMesh

  • Adds object as child of this object.

    Parameters

    • Rest...objects: Object3D[]

    Returns CircleMesh

addIfNotExists

  • addIfNotExists(...objects): CircleMesh

  • Parameters

    • Rest...objects: Object3D[]

    Returns CircleMesh

highlight

  • highlight(): void

  • Returns void

remove

  • remove(...objects): CircleMesh

  • Removes object as child of this object.

    Parameters

    • Rest...objects: Object3D[]

    Returns CircleMesh

removeChildren

  • removeChildren(): CircleMesh

  • Returns CircleMesh

removeFromParent

  • removeFromParent(): CircleMesh

  • Returns CircleMesh

setPoints

  • setPoints(params): void

  • Parameters

    • params: Partial<CircleData>

    Returns void

setStyle

  • setStyle(params): void

  • Parameters

    • params: Partial<ColoredMeshStyle>

    Returns void

unhighlight

  • unhighlight(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods