Options
All
  • Public
  • Public/Protected
  • All
Menu

SceneItemsApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Methods

createSceneItem

  • Create a scene-item for a scene. Provide the source geometry either via part-revision or geometry-set UUID using relationship.source or by supplied IDs using attributes.source. Provide an existing scene using relationship.source to clone it. Provide the hierarchical parent either via scene-item UUID using relationship.source or by supplied ID using attributes.parent. To reduce the time taken creating many hierarchical scene-items, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root. This API is asynchronous, returning the location of a queued-scene-item. Check the status via the getQueuedSceneItem API. For details, see our Render static scenes guide.

    throws

    {RequiredError}

    memberof

    SceneItemsApi

    Parameters

    Returns Promise<AxiosResponse<QueuedJob, any>>

deleteSceneItem

  • Delete a scene-item.

    throws

    {RequiredError}

    memberof

    SceneItemsApi

    Parameters

    Returns Promise<AxiosResponse<void, any>>

getQueuedSceneItem

  • Get a queued-scene-item. The response is either the status if running or error or, upon completion, redirects to the created scene-item. Once created, commit the scene via the updateScene API. For details, see our Render static scenes guide.

    throws

    {RequiredError}

    memberof

    SceneItemsApi

    Parameters

    Returns Promise<AxiosResponse<QueuedJob, any>>

getQueuedSceneItemDeletion

getSceneItem

getSceneItems

updateSceneItem