Scene Controller

interface ICwAPI3DSceneController

Public Functions

virtual ICwAPI3DString *getLastError(int32_t *aErrorCode) = 0

Gets the last error.

Parameters:

aErrorCode – [out] [int32_t*] The error code.

Returns:

[ICwAPI3DString*] The error string.

virtual bool addScene(const character *aName) = 0

Adds a new scene.

Parameters:

aName – [in] [const character*] The scene name.

Returns:

[bool] True if the operation succeeded, false otherwise.

virtual bool renameScene(const character *aOldName, const character *aNewName) = 0

Renames a scene.

Parameters:

  • aOldName – [in] [const character*] The old scene name.

  • aNewName – [in] [const character*] The new scene name.

Returns:

[bool] True if the operation succeeded, false otherwise.

virtual bool deleteScene(const character *aName) = 0

Deletes a scene.

Parameters:

aName – [in] [const character*] The scene name.

Returns:

[bool] True if the operation succeeded, false otherwise.

virtual bool addElementsToScene(const character *aName, ICwAPI3DElementIDList *aElementIdList) = 0

Adds elements to a scene.

Parameters:
Returns:

[bool] True if the operation succeeded, false otherwise.

virtual bool removeElementsFromScene(const character *aName, ICwAPI3DElementIDList *aElementIdList) = 0

Removes elements from a scene.

Parameters:
Returns:

[bool] True if the operation succeeded, false otherwise.

virtual ICwAPI3DElementIDList *getElementsFromScene(const character *aName) = 0

Gets the elements from a scene.

Parameters:

aName – [in] [const character*] The scene name.

Returns:

[ICwAPI3DElementIDList*] The element id list.

virtual bool activateScene(const character *aName) = 0

Activates a scene.

Parameters:

aName – [in] [const character*] The scene name.

Returns:

[bool] True if the operation succeeded, false otherwise.

virtual void clearErrors() = 0

Clears all errors.

virtual ICwAPI3DStringList *getSceneList() = 0

Gets the list of scenes.

Returns:

[ICwAPI3DStringList*] The list of scene names.

virtual uint64_t groupScenes(ICwAPI3DStringList *aSceneNames) = 0

Groups the scenes to a scene group.

Parameters:

aSceneNames – [in] [ICwAPI3DStringList*] The scene names.

Returns:

[uint64_t] The index of the new group.

virtual void ungroupScenes(uint64_t aGroupIndex) = 0

Deletes the Group of scenes.

Parameters:

aGroupIndex – [in] [uint64_t] The index of the group.

virtual bool isScenePresent(const character *aName) = 0

Checks if a scene is present.

Parameters:

aName – [in] [const character*] The name of the scene to check.

Returns:

[bool] True if the scene is present, false otherwise.

virtual void setGroupTabColor(const character *aSceneGroupName, int aRed, int aGreen, int aBlue, int aAlpha = 255) = 0

Set group tab color.

Parameters:

  • aSceneGroupName – [in] [const character*] The name of the scene group.

  • aRed – [in] [int] Red

  • aGreen – [in] [int] Green

  • aBlue – [in] [int] Blue

  • aAlpha – [in] [int] Alpha from 0 to 255, default is 255 (opaque)

virtual void renameSceneGroup(const character *aOldName, const character *aNewName) = 0

Rename the scene group.

Parameters:

  • aOldName – [in] [const character*] The old scene group name.

  • aNewName – [in] [const character*] The new scene group name.

virtual uint64_t getGroupIndexByName(const character *aSceneGroupName) = 0

Gets the index of a scene group by its name.

Parameters:

aSceneGroupName – [in] [const character*] The group name.

Returns:

[uint64_t] The index of the group, or std::numeric_limits<uint64_t>::max() if not found.

virtual void renameSceneGroupByIndex(uint64_t aGroupIndex, const character *aNewName) = 0

Rename the scene group by its index.

Parameters:

  • aGroupIndex – [in] [uint64_t] The index of the group.

  • aNewName – [in] [const character*] The new scene group name.

virtual uint64_t groupScenesWithName(ICwAPI3DStringList *aSceneNames, const character *aGroupName) = 0

Groups the scenes to a scene group and sets the name of the new group.

Parameters:

  • aSceneNames – [in] [ICwAPI3DStringList*] The scene names to group.

  • aGroupName – [in] [const character*] The name of the new group.

Returns:

[uint64_t] The index of the new group.