roavatar-renderer
    Preparing search index...

    Class RBXRendererScene

    Created by calling RBXRenderer.addScene()

    Index

    Constructors

    constructor

    Properties

    _wellLitDirectionalLightIntensity addedInstances ambientLight? camera compiledRenderDesc controls destroyConnections destroyed directionalLight? directionalLight2? effectComposer failedRenderDesc forceAccurateNeedsRegeneration isRenderingMesh lookAwayDistance lookAwayVector particlesStartFull? particlesStartFullFramerate plane? renderDescs scene scissor? shadowEnabled shadowPlane? shadowResolution shouldAnimate viewport?

    Accessors

    wellLitDirectionalLightIntensity

    Methods

    areInstancesCompiled destroy exportGLTF isFullyCompiled noRect setRect

    Constructors

    Properties

    _wellLitDirectionalLightIntensity

    _wellLitDirectionalLightIntensity: number = ...
    addedInstances: Instance[] = []
    ambientLight?: AmbientLight
    camera: PerspectiveCamera = ...
    compiledRenderDesc: Event = ...
    controls: OrbitControls<Camera> | undefined
    destroyConnections: Map<Instance, Connection> = ...
    destroyed: boolean = false
    directionalLight?: DirectionalLight
    directionalLight2?: DirectionalLight
    effectComposer: EffectComposer | undefined
    failedRenderDesc: Event = ...
    forceAccurateNeedsRegeneration: boolean = false
    isRenderingMesh: Map<Instance, boolean> = ...
    lookAwayDistance: number = 6
    lookAwayVector: Vec3 = ...
    particlesStartFull?: number = undefined
    particlesStartFullFramerate: number = FLAGS.PARTICLES_START_FULL_FRAMERATE
    plane?: Mesh<
        BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        Material<MaterialEventMap> | Material<MaterialEventMap>[],
        Object3DEventMap,
    >
    renderDescs: Map<Instance, RenderDesc> = ...
    scene: Scene = ...
    scissor?: [number, number, number, number]
    shadowEnabled: boolean = true
    shadowPlane?: Mesh<
        BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        Material<MaterialEventMap> | Material<MaterialEventMap>[],
        Object3DEventMap,
    >
    shadowResolution: [number, number] = ...
    shouldAnimate: boolean = true
    viewport?: [number, number, number, number]

    Accessors

    Methods

    • Checks that renderDescs for provided instances are compiled, ignores instances that shouldn't be compiled or haven't been added

      Parameters

      Returns boolean

      true if all provided instances's renderDescs have been compiled

    • Destroys all renderDescs but does not call Destroy on instances

      Returns void

    • Exports scene as a GLTF or GLB

      Parameters

      • name: string = "scene"

        Name of the resulting file if autoDownload is true

      • autoDownload: boolean = true

        If resulting file should be auto downloaded

      • Optionaloptions: GLTFExportOptions

      Returns Promise<ArrayBuffer | { [key: string]: unknown }>

      The GLB (buffer) or GLTF (object)

    • Checks that all renderDescs are compiled

      Returns boolean

      true if all have been compiled

    • Forces viewport to be within bounds

      Parameters

      • bounds: DOMRect

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods