Small World Engine API Reference - v0.76.20
    Preparing search index...

    Class DynamicReflectionProbe

    A probe that renders the environment into a CubeMap from its position. Features time-slicing to update only a subset of faces per frame for better performance.

    Hierarchy (View Summary)

    Index
    constructor
    behaviors bounds castShadow children facesPerFrame frustumCulled geometry inFrustum isCollidable isPickable isStatic isVisible localMatrix material name onPointerClick? onPointerDown? onPointerEnter? onPointerLeave? onPointerMove? onPointerUp? parent position probeCamera receiveShadow renderTarget rigidBody? rotation scale tag? uuid worldMatrix
    add addBehavior computeBounds getObjectByName getWorldPosition lookAt remove removeBehavior setPosition setRotation setScale translate updateMatrixWorld updateReflection
    behaviors: Behavior[] = []
    bounds: BoundingVolume | undefined = undefined

    The physical bounding volume of the object.

    castShadow: boolean = false
    children: Object3D[] = []
    facesPerFrame: number = 1

    Number of faces to update per frame (1-6). Default is 1 for max performance.

    frustumCulled: boolean = true
    geometry: GeometryDataInterface | undefined = undefined
    inFrustum: boolean = true
    isCollidable: boolean = true

    Whether this object should generate bounds and participate in physics/raycasting. Defaults to true.

    isPickable: boolean = false
    isStatic: boolean = false
    isVisible: boolean = true
    localMatrix: Matrix4 = ...
    material: AbstractMaterial | undefined = undefined
    name: string = ""
    onPointerClick?: () => void
    onPointerDown?: (ray: Ray, intersectionPoint: Vector3D) => void
    onPointerEnter?: () => void
    onPointerLeave?: () => void
    onPointerMove?: (ray: Ray) => void
    onPointerUp?: () => void
    parent: Object3D | undefined = undefined
    position: Vector3D = ...
    probeCamera: Camera
    receiveShadow: boolean = false
    renderTarget: RenderTargetCube
    rigidBody?: RigidBody
    rotation: Vector3D = ...
    scale: Vector3D = ...
    tag?: string

    Optional app-defined category tag, for typed identification instead of matching on name.

    uuid: string = ...
    worldMatrix: Matrix4 = ...

    • Reads this object's position in world space, i.e. after resolving the full parent chain -- unlike position, which is always local to its immediate parent. Requires worldMatrix to be current (see updateMatrixWorld()).

      Parameters

      • out: Vector3D = ...

        Optional vector to write into, to avoid allocating one per call.

      Returns Vector3D

    • Updates the environment probe. Renders the specified number of faces into the CubeMap. Call this in your update loop before the main render.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods