Interface BoundsHelperOptions

BoundsHelper component options

Export

BoundsHelperOptions

Date

2024.6.11

Author

yisky

interface BoundsHelperOptions {
    color?: ColorRepresentation;
    lookAt?: Vector3;
    occluded?: boolean;
    onAfterRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void);
    onBeforeRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void);
    position?: Vector3;
    quaternion?: Quaternion;
    queryMask?: QueryMask;
    renderOrder?: RenderOrder;
    rotation?: Euler;
    scale?: Vector3;
    updateEveryFrame?: boolean;
    userData?: {
        [key: string]: any;
    };
}

Hierarchy

  • RendererOptions
    • BoundsHelperOptions

Properties

color? lookAt? occluded? onAfterRender? onBeforeRender? position? quaternion? queryMask? renderOrder? rotation? scale? updateEveryFrame? userData?

Properties

Optionalcolor

color?: ColorRepresentation

The color of the bounds helper, '#00ff00'.

Memberof

BoundsHelperOptions

OptionallookAt

lookAt?: Vector3

Rotates the object to face a point in world space.

Memberof

LightformerOptions

Optionaloccluded

occluded?: boolean

Can the bounds helper be occluded, true.

Memberof

BoundsHelperOptions

OptionalonAfterRender

onAfterRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

After render callback

Memberof

RendererOptions

OptionalonBeforeRender

onBeforeRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

Before render callback

Memberof

RendererOptions

Optionalposition

position?: Vector3

Local Position

Memberof

LightformerOptions

Optionalquaternion

quaternion?: Quaternion

Local quaternion

Memberof

RendererOptions

OptionalqueryMask

queryMask?: QueryMask

Query mask

Memberof

RendererOptions

OptionalrenderOrder

renderOrder?: RenderOrder

Render order

Memberof

RendererOptions

Optionalrotation

rotation?: Euler

Local rotation

Memberof

LightformerOptions

Optionalscale

scale?: Vector3

Local Scale

Memberof

LightformerOptions

OptionalupdateEveryFrame

updateEveryFrame?: boolean

Whether update every frame, false.

Memberof

BoundsHelperOptions

OptionaluserData

userData?: {
    [key: string]: any;
}

The component user data, default is {}

Memberof

ComponentOptions

Settings

Member Visibility

On This Page

Properties