Interface RendererObjectInternal

Interface through which a ViewObject controls the appearance of a SceneObject in a Viewer.

While a Scene is attached to a Viewer, the Viewer attaches a RendererObject to SceneObject.rendererObject on each of the Scene's SceneObjects, to provide an interface through which the Viewer's ViewObjects can control the appearance of the SceneObjects within their respective Views.

Internally, the Viewer's viewer!Renderer attaches these to SceneObject.rendererObject. When we update properties like ViewObject.visible, the ViewObject will upload those updates through this interface into the viewer!Renderer.

When a View

interface RendererObject {
    aabb: FloatArrayParam;
    id: string;
    layerId: string;
    rendererModel: RendererModel;
    setClippable(viewIndex: number, clippable: boolean): void | SDKError;
    setCollidable(viewIndex: number, collidable: boolean): void | SDKError;
    setColorize(viewIndex: number, color?: FloatArrayParam): void | SDKError;
    setCulled(viewIndex: number, culled: boolean): void | SDKError;
    setHighlighted(viewIndex: number, highlighted: boolean): void | SDKError;
    setOpacity(viewIndex: number, opacity?: number): void | SDKError;
    setPickable(viewIndex: number, pickable: boolean): void | SDKError;
    setSelected(viewIndex: number, selected: boolean): void | SDKError;
    setVisible(viewIndex: number, visible: boolean): void | SDKError;
    setXRayed(viewIndex: number, xrayed: boolean): void | SDKError;
}

Properties

The axis-aligned world-space 3D boundary of this RendererObject.

id: string

Unique identifier for this RendererObject.

layerId: string

The ID of a ViewLayer in which the ViewObject exclusively appears.

rendererModel: RendererModel

The RendererModel containing this RendererObject.

Methods

  • Determines whether the ViewObject participates in boundary calculations and collisions.

    Parameters

    • viewIndex: number

      Index of the View.

    • collidable: boolean

      Whether the object should be collidable.

    Returns void | SDKError

    void - Success.