DzScene Class Reference
[Core Objects]

The main scene container. More...

Inheritance diagram for DzScene:

DzBase QObject Object List of all members.

Enumerations



enum  DzOpenMethod { DefaultMethod = 0, OpenNew, MergeFile }
enum  IncludeFlags {
  DzObjectsOnly = 0x00000000, DzIncludeLightsFlag = 0x00000001, DzIncludeCamerasFlag = 0x00000002, DzIncludeNonShadowersFlag = 0x00000004,
  DzIncludeNonVisibleFlag = 0x00000008, DzIncludeAllFlag = 0x000000ff
}

Methods

DzError addDataItem (DzSceneData item)
Boolean addNode (DzNode node)
DzError addWSModifier (DzWSModifier modifier, Number index=-1)
void beginTimeEdit ()
void clear ()
DzCamera findCamera (String name)
DzCamera findCameraByLabel (String label)
DzSceneData findDataItem (String name)
DzLight findLight (String name)
DzLight findLightByLabel (String label)
DzNode findNode (String name)
DzNode findNodeByLabel (String label)
Number findNodeIndex (DzNode node)
DzSkeleton findSkeleton (String name)
DzSkeleton findSkeletonByLabel (String label)
Number findSkeletonIndex (DzSkeleton skelton)
void finishTimeEdit ()
DzTimeRange getAnimRange ()
DzAudioClip getAudio ()
Number getAudioStartFrame ()
DzBackdrop getBackdrop ()
DzBox3 getBoundingBox (Number flags=DzIncludeAllFlag)
DzCamera getCamera (Number which)
Array getCameraList ()
String getFilename ()
Number getFrame ()
DzNode getHighlightNode ()
DzLight getLight (Number which)
Array getLightList ()
DzNode getNode (Number which)
Array getNodeList ()
Number getNumCameras ()
Number getNumLights ()
Number getNumNodes ()
Number getNumSelectedCameras ()
Number getNumSelectedLights ()
Number getNumSelectedNodes ()
Number getNumSelectedSkeletons ()
Number getNumSelectedTimeRanges ()
Number getNumSkeletons ()
Number getNumStorablesInScene ()
Number getNumWSModifiers ()
DzTimeRange getPlayRange ()
DzNode getPrimarySelection ()
DzCamera getSelectedCamera (Number index)
Array getSelectedCameraList ()
DzLight getSelectedLight (Number index)
Array getSelectedLightList ()
DzNode getSelectedNode (Number index)
Array getSelectedNodeList ()
DzSkeleton getSelectedSkeleton (Number index)
Array getSelectedSkeletonList ()
DzSkeleton getSkeleton (Number which)
Array getSkeletonList ()
DzTime getTime ()
DzTime getTimeStep ()
DzWSModifier getWSModifier (Number which)
Array getWSModifierList ()
void invalidate ()
Boolean isClearing ()
Boolean isLoading ()
Boolean isLoopingEnabled ()
Boolean isPlaying ()
DzError loadScene (String filename, DzOpenMethod method)
void loopPlayback (Boolean onOff)
void markChanged ()
Boolean needsSave ()
void pause ()
void play (Boolean realtime=true)
void removeAllCameras ()
void removeAllLights ()
DzError removeDataItem (DzSceneData item)
Boolean removeNode (DzNode node)
void removeSelected ()
DzError removeWSModifier (DzWSModifier modifier)
DzError saveScene (String filename="")
void saveThumbnail (String filename)
void selectAllNodes (Boolean onOff)
void selectAllSkeletons (Boolean onOff)
void selectAllTime (Boolean onOff)
void setAnimRange (DzTimeRange range)
void setAudio (DzAudioClip audio, Number startFrame=0)
void setBackdrop (DzBackdrop backdrop)
void setFrame (Number frame)
void setHighlightNode (DzNode node)
void setPlayRange (DzTimeRange range)
Boolean setPrimarySelection (DzNode node)
void setTime (DzTime time)
void setTimeStep (DzTime time)
void stepTime (Number nFrames=1, Boolean forward=true)
void update ()

Signals

void aboutToRemoveNode (DzNode node)
 Signature: "aboutToRemoveNode(DzNode*)"
void aboutToRender (DzRenderer r)
 Signature: "aboutToRender(DzRenderer*)"
void animRangeChanged (DzTimeRange range)
 Signature: "animRangeChanged(const DzTimeRange&)"
void cameraAdded (DzCamera node)
 Signature: "cameraAdded(DzCamera*)"
void cameraListChanged ()
 Signature: "cameraListChanged()"
void cameraRemoved (DzCamera node)
 Signature: "cameraRemoved(DzCamera*)"
void cameraSelectionListChanged ()
 Signature: "cameraSelectionListChanged()"
void drawnDataChanged ()
 Signature: "drawnDataChanged()"
void highlightNodeChanged (DzNode node)
 Signature: "highlightNodeChanged(DzNode*)"
void lightAdded (DzLight node)
 Signature: "lightAdded(DzLight*)"
void lightListChanged ()
 Signature: "lightListChanged()"
void lightRemoved (DzLight node)
 Signature: "lightRemoved(DzLight*)"
void lightSelectionListChanged ()
 Signature: "lightSelectionListChanged()"
void loopPlaybackChanged (Boolean onOff)
 Signature: "loopPlaybackChanged(bool)"
void materialListChanged ()
 Signature: "materialListChanged()"
void materialSelectionChanged ()
 Signature: "materialSelectionChanged()"
void nodeAdded (DzNode node)
 Signature: "nodeAdded(DzNode*)"
void nodeListChanged ()
 Signature: "nodeListChanged()"
void nodeRemoved (DzNode node)
 Signature: "nodeRemoved(DzNode*)"
void nodeSelectionListChanged ()
 Signature: "nodeSelectionListChanged()"
void playbackFinished ()
 Signature: "playbackFinished()"
void playbackStarted ()
 Signature: "playbackStarted()"
void playRangeChanged (DzTimeRange range)
 Signature: "playRangeChanged(const DzTimeRange&)"
void primarySelectionChanged (DzNode node)
 Signature: "primarySelectionChanged(DzNode*)"
void renderFinished (DzRenderer r)
 Signature: "renderFinished(DzRenderer*)"
void sceneCleared ()
 Signature: "sceneCleared()"
void sceneClearStarting ()
 Signature: "sceneClearStarting()"
void sceneFilenameChanged (String newName)
 Signature: "sceneFilenameChanged(const QString&)"
void sceneLoaded ()
 Signature: "sceneLoaded()"
void sceneLoadStarting ()
 Signature: "sceneLoadStarting()"
void skeletonAdded (DzSkeleton node)
 Signature: "skeletonAdded(DzSkeleton*)"
void skeletonListChanged ()
 Signature: "skeletonListChanged()"
void skeletonRemoved (DzSkeleton node)
 Signature: "skeletonRemoved(DzSkeleton*)"
void skeletonSelectionListChanged ()
 Signature: "skeletonSelectionListChanged()"
void timeChanged (DzTime time)
 Signature: "timeChanged(DzTime)"
void timeChanging (DzTime newTime)
 Signature: "timeChanging(DzTime)"
void timeSelectionChanged ()
 Signature: "timeSelectionChanged()"
void timeStepChanged (DzTime time)
 Signature: "timeStepChanged(DzTime)"
void wsModifierAdded (DzWSModifier modifier)
 Signature: "wsModifierAdded(DzWSModifier*)"
void wsModifierRemoved (DzWSModifier modifier)
 Signature: "wsModifierRemoved(DzWSModifier*)"
void wsModifierStackChanged ()
 Signature: "wsModifierStackChanged()"

Detailed Description

The main scene container.

There is only one of these objects in the application. It is the communication hub between the core code and the interface, so it tracks all nodes, skeletons, lights, cameras, etc. that become part of the scene. This object is directly available using the global Scene global variable .


Member Enumeration Documentation

enum DzScene::DzOpenMethod

Enumerated open methods

Enumerator:
DefaultMethod  DefaultMethod - If no nodes (or only the default camera) exist, this behaves as OpenNew. Otherwise, this behaves as MergeFile.
OpenNew  OpenNew - Resets the scene to its initial, clean state. All scene data is deleted and the undo stack is cleared.
MergeFile  MergeFile - Merges the file with any pre-existing elements in the scene.

enum DzScene::IncludeFlags

Enumerated flags for determining what to include when calculating the scene bounding box.

Enumerator:
DzObjectsOnly  Only visible items with geometry that cast shadows will be included.
DzIncludeLightsFlag  Include lights in the bounding box.
DzIncludeCamerasFlag  Include cameras in the bounding box.
DzIncludeNonShadowersFlag  Include items that do not cast shadows in the bounding box.
DzIncludeNonVisibleFlag  Include items that are not visible in the bounding box.
DzIncludeAllFlag  Include all nodes in the bounding box.


Member Function Documentation

DzScene::aboutToRemoveNode ( DzNode  node  )  [signal]

Signature: "aboutToRemoveNode(DzNode*)"

Transmitted immediately before a node is removed from the scene.

Parameters:
node The node to be removed from the scene

DzScene::aboutToRender ( DzRenderer  renderer  )  [signal]

Signature: "aboutToRender(DzRenderer*)"

Emitted just before the scene is rendered

Parameters:
renderer A pointer to the renderer that will be rendering the scene

DzError DzScene::addDataItem ( DzSceneData  item  ) 

Adds a scene data item to the scene.

Parameters:
item A pointer to the data item to add to the scene. The scene takes ownership of this object and deletes it when it is no longer used.
Returns:
DZ_NO_ERROR on success, or an error code if it failed.

Boolean DzScene::addNode ( DzNode  node  ) 

Adds a node to the scene if it is not already here.

Parameters:
newNode A pointer to the node to add to the scene. The scene takes ownership of this object and deletes it when it is no longer used.

DzError DzScene::addWSModifier ( DzWSModifier  modifier,
Number  index = -1 
)

Adds a world-space modifier to the scene's modifier stack

Parameters:
modifier Pointer to the World-Space Modifier to add to the scene. The scene takes ownership of this object and deletes it when it is no longer used.
index The location in the list that where the modifier will be inserted. If index is less than 0, the modifier is appended to the end of the stack.
Returns:
DZ_NO_ERROR on success, otherwise an error code.

DzScene::animRangeChanged ( DzTimeRange  range  )  [signal]

Signature: "animRangeChanged(const DzTimeRange&)"

Transmitted after the scene play range is changed.

Parameters:
range The new animation range of the scene

void DzScene::beginTimeEdit (  ) 

Starts a time-editing operation. All changes to scene time, play range, & animation range that occur between this call and a call to finishTimeEdit() will be wrapped into a single undo item.

Every call to beginTimeEdit() should be matched with a call to finishTimeEdit().

DzScene::cameraAdded ( DzCamera  node  )  [signal]

Signature: "cameraAdded(DzCamera*)"

Transmitted when cameras are added to the scene.

Parameters:
node The camera added to the scene

void DzScene::cameraListChanged (  )  [signal]

Signature: "cameraListChanged()"

Transmitted when cameras are added to or removed from the scene.

DzScene::cameraRemoved ( DzCamera  node  )  [signal]

Signature: "cameraRemoved(DzCamera*)"

Transmitted when cameras are removed from the scene.

Parameters:
node The camera removed from the scene

void DzScene::cameraSelectionListChanged (  )  [signal]

Signature: "cameraSelectionListChanged()"

Transmitted after the camera selection list changes.

void DzScene::clear (  ) 

Resets the scene to its initial, clean state. All data is deleted and the undo stack is cleared.

void DzScene::drawnDataChanged (  )  [signal]

Signature: "drawnDataChanged()"

Transmitted if the scene has changed and needs to be redrawn

DzCamera DzScene::findCamera ( String  name  ) 

Attempts to find a Camera with the given name in the scene.

Parameters:
name The name of the camera to find.
Returns:
A camera in the scene with the given name, or NULL if a matching camera was not found.

DzCamera DzScene::findCameraByLabel ( String  label  ) 

Attempts to find a Camera with the given label in the scene.

Parameters:
label The label of the camera to find.
Returns:
A camera in the scene with the given label, or NULL if a matching camera was not found.

DzSceneData DzScene::findDataItem ( String  name  ) 

Returns:
A pointer to the scene data item with the given id. NULL if no scene data item is found with the matching id.

DzLight DzScene::findLight ( String  name  ) 

Attempts to find a Light with the given name in the scene.

Parameters:
name The name of the light to find.
Returns:
A light in the scene with the given name, or NULL if a matching light was not found.

DzLight DzScene::findLightByLabel ( String  label  ) 

Attempts to find a Light with the given label in the scene.

Parameters:
label The label of the light to find.
Returns:
A light in the scene with the given label, or NULL if a matching light was not found.

DzNode DzScene::findNode ( String  name  ) 

Attempts to find a node with the given name in the scene.

Parameters:
name The name of the node to find.
Returns:
A node in the scene with the given name, or NULL if a matching node was not found.

DzNode DzScene::findNodeByLabel ( String  label  ) 

Attempts to find a node with the given label in the scene.

Parameters:
label The label of the node to find.
Returns:
A node in the scene with the given label, or NULL if a matching node was not found.

Number DzScene::findNodeIndex ( DzNode  node  ) 

Parameters:
node A pointer to the node to search for in the nodes list
Returns:
The index of the Node item in the array, or -1 if not found.

DzSkeleton DzScene::findSkeleton ( String  name  ) 

Attempts to find a Skeleton with the given name in the scene.

Parameters:
name The name of the skeleton to find.
Returns:
A skeleton in the scene with the given name, or NULL if a matching skeleton was not found.

DzSkeleton DzScene::findSkeletonByLabel ( String  label  ) 

Attempts to find a Skeleton with the given label in the scene.

Parameters:
label The label of the skeleton to find.
Returns:
A skeleton in the scene with the given label, or NULL if a matching skeleton was not found.

Number DzScene::findSkeletonIndex ( DzSkeleton  skeleton  ) 

Parameters:
skeleton A pointer to the skeleton to search for in the nodes list
Returns:
The index of the Skeleton item in the array, or -1 if not found.

void DzScene::finishTimeEdit (  ) 

Ends a time editing operation started with a call to beginTimeEdit().

DzTimeRange DzScene::getAnimRange (  ) 

Returns:
The current animation range
See also:
setAnimRange()

DzAudioClip DzScene::getAudio (  ) 

Returns:
An editable copy of the current audio clip for the scene. This will be NULL if there is no audio for the scene.
See also:
setAudio()

int DzScene::getAudioStartFrame (  ) 

Returns:
The frame number on which the audio should start playing.

DzBackdrop DzScene::getBackdrop (  ) 

Returns:
A pointer to the current backdrop object for the scene.
See also:
setBackdrop()

DzBox3 DzScene::getBoundingBox ( Number  flags = DzIncludeAllFlag  ) 

Calculate the bounding box for the current scene.

Parameters:
flags A set of flags that specify which types of nodes should be included.
Returns:
A world-space bounding box that encloses all items in the scene (that match the criteria of the given flags).

DzCamera DzScene::getCamera ( Number  which  ) 

Returns:
A pointer to the Camera at the given index in the list. This method is slow. For fast list traversal, use getCameras() instead.

Array DzScene::getCameraList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient cameraListIterator() method instead.

Returns:
A QObjectList containing all the cameras in the scene.

String DzScene::getFilename (  ) 

Returns:
The filename that this scene was last saved to or read from, if any.

Number DzScene::getFrame (  ) 

Returns:
The current time as a frame number based on the current time step.
See also:
getFrame()

DzNode DzScene::getHighlightNode (  ) 

Returns:
Currently highlighted node in the scene.

DzLight DzScene::getLight ( Number  which  ) 

Returns:
A pointer to the Light at the given index in the list. This method is slow. For fast list traversal, use getLights() instead.

Array DzScene::getLightList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient lightListIterator() method instead.

Returns:
A QObjectList containing all the lights in the scene.

DzNode DzScene::getNode ( Number  which  ) 

Parameters:
which The index of the node to return.
Returns:
A pointer to the Node at the given index in the list. This method is slow. For fast list traversal, use getNodes() instead.

Array DzScene::getNodeList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient nodeListIterator() method instead.

Returns:
A QObjectList containing all the nodes in the scene.

Number DzScene::getNumCameras (  ) 

Returns:
The number of Cameras in the scene.

Number DzScene::getNumLights (  ) 

Returns:
The number of Lights in the scene.

Number DzScene::getNumNodes (  ) 

Returns:
The number of Nodes in the scene.

Number DzScene::getNumSelectedCameras (  ) 

Returns:
The number of currently selected cameras.

Number DzScene::getNumSelectedLights (  ) 

Returns:
The number of currently selected lights.

Number DzScene::getNumSelectedNodes (  ) 

Returns:
The number of currently selected nodes.

Number DzScene::getNumSelectedSkeletons (  ) 

Returns:
The number of currently selected skeletons.

Number DzScene::getNumSelectedTimeRanges (  ) 

Returns:
The number of selected time ranges

Number DzScene::getNumSkeletons (  ) 

Returns:
The number of Skeletons in the scene.

int DzScene::getNumStorablesInScene (  ) 

Returns:
The number of DzStorable items in the scene.

Number DzScene::getNumWSModifiers (  ) 

Returns:
The number of World-Space Modifiers in the scene.

DzTimeRange DzScene::getPlayRange (  ) 

Returns:
The current play range
See also:
setPlayRange()

DzNode DzScene::getPrimarySelection (  ) 

Returns:
The primary selected DzNode, or NULL if there is no current selection. The primary selected node is the last item that was selected, or can be set via function calls.

DzCamera DzScene::getSelectedCamera ( Number  index  ) 

Parameters:
which The index of the selected camera to return.
Returns:
The camera at index in the list of selected nodes.
For fast list traversal, use getSelectedCameras() instead.

Array DzScene::getSelectedCameraList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient selectedCameraListIterator() method instead.

Returns:
A QObjectList containing all the selected cameras in the scene.

DzLight DzScene::getSelectedLight ( Number  index  ) 

Parameters:
which The index of the selected light to return.
Returns:
The light at index in the list of selected nodes.
For fast list traversal, use getSelectedLights() instead.

Array DzScene::getSelectedLightList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient selectedLightListIterator() method instead.

Returns:
A QObjectList containing all the selected lights in the scene.

DzNode DzScene::getSelectedNode ( Number  index  ) 

Parameters:
which The index of the selected node to return.
Returns:
The node at index in the list of selected nodes.
For fast list traversal, use getSelectedNodes() instead.

Array DzScene::getSelectedNodeList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient selectedNodeListIterator() method instead.

Returns:
A QObjectList containing all the selected nodes in the scene.

DzSkeleton DzScene::getSelectedSkeleton ( Number  index  ) 

Parameters:
which The index of the selected skeleton to return.
Returns:
The skeleton at index in the list of selected skeletons.
For fast list traversal, use selectedSkeletonListIterator() instead.

Array DzScene::getSelectedSkeletonList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient selectedSkeletonListIterator() method instead.

Returns:
A QObjectList containing all the selected skeletons in the scene.

DzSkeleton DzScene::getSkeleton ( Number  which  ) 

Returns:
A pointer to the Skeleton at the given index in the list. This method is slow. For fast list traversal, use getSkeletons() instead.

Array DzScene::getSkeletonList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient skeletonListIterator() method instead.

Returns:
A QObjectList containing all the skeletons in the scene.

DzTime DzScene::getTime (  ) 

Returns:
The current scene time as a DzTime
See also:
setTime()

DzTime DzScene::getTimeStep (  ) 

Returns:
The time step the animation is incremented by at each frame.
See also:
setTimeStep()

DzWSModifier DzScene::getWSModifier ( Number  which  ) 

Returns:
A pointer to the World-Space modifier at the given index in the list. This method is slow. For fast list traversal, use getWSModifiers() instead.

Array DzScene::getWSModifierList (  ) 

This function is mainly provided for DAZ Script access. It is recommended that plugin developers use the much more efficient wsModifierListIterator() method instead.

Returns:
A QObjectList containing all the world-space modifiers in the scene.

DzScene::highlightNodeChanged ( DzNode  node  )  [signal]

Signature: "highlightNodeChanged(DzNode*)"

Transmitted when the highlight node changes.

Parameters:
node The new highlight node of the scene

void DzScene::invalidate (  ) 

Invalidates the scene flagging it as needing to be redrawn.

bool DzScene::isClearing (  ) 

Returns:
true if the scene is currently in a clearing operation, otherwise, false.

bool DzScene::isLoading (  ) 

Returns:
true if the scene is currently in a loading operation, otherwise false.

Boolean DzScene::isLoopingEnabled (  ) 

Returns:
true if the looping of playback is enabled.

Boolean DzScene::isPlaying (  ) 

Returns:
true if the animation is currently playing.

DzScene::lightAdded ( DzLight  node  )  [signal]

Signature: "lightAdded(DzLight*)"

Transmitted when lights are added to the scene.

Parameters:
node The light added to the scene

void DzScene::lightListChanged (  )  [signal]

Signature: "lightListChanged()"

Transmitted when lights are added to or removed from the scene.

DzScene::lightRemoved ( DzLight  node  )  [signal]

Signature: "lightRemoved(DzLight*)"

Transmitted when lights are removed from the scene.

Parameters:
node The light removed from the scene

void DzScene::lightSelectionListChanged (  )  [signal]

Signature: "lightSelectionListChanged()"

Transmitted after the light selection list changes.

DzError DzScene::loadScene ( String  filename,
DzOpenMethod  method 
)

Attempts to load a native file from the given filename.

Parameters:
filename The name of the file to load
method The method for combining the file contents with the current scene contents.
Returns:
DZ_NO_ERROR on success, otherwise an error code.

void DzScene::loopPlayback ( Boolean  onOff  ) 

Sets looping of playback on/off

Parameters:
onOff If true, playback of animation will continue until the user stops it, looping back to the first frame each time the end of the animation is reached. If false, playback of the animation will stop when the end of the animation is reached.

DzScene::loopPlaybackChanged ( Boolean  onOff  )  [signal]

Signature: "loopPlaybackChanged(bool)"

Transmitted when the enabled state of playback looping changes.

void DzScene::markChanged (  ) 

Indicate that the scene has changed since the last save.

void DzScene::materialListChanged (  )  [signal]

Signature: "materialListChanged()"

Emitted when the material list of a node in the scene has changed.

void DzScene::materialSelectionChanged (  )  [signal]

Signature: "materialSelectionChanged()"

Emitted when the material selection in the scene has changed.

Boolean DzScene::needsSave (  ) 

Returns:
true if the scene needs to be saved, otherwise false.

DzScene::nodeAdded ( DzNode  node  )  [signal]

Signature: "nodeAdded(DzNode*)"

Transmitted when nodes are added to the scene.

Parameters:
node The node added to the scene

void DzScene::nodeListChanged (  )  [signal]

Signature: "nodeListChanged()"

Transmitted when nodes are added to or removed from the scene.

DzScene::nodeRemoved ( DzNode  node  )  [signal]

Signature: "nodeRemoved(DzNode*)"

Transmitted when nodes are removed from the scene.

Parameters:
node The node removed from the scene

void DzScene::nodeSelectionListChanged (  )  [signal]

Signature: "nodeSelectionListChanged()"

Transmitted after the node selection list changes.

void DzScene::pause (  ) 

Pauses playback of the current animation

void DzScene::play ( Boolean  realtime = true  ) 

Start playback of the current play range

Parameters:
realtime If true, frames will be dropped or paused as needed to keep the animation playing in realtime. Otherwise, the animation is played frame by frame as it can be drawn

void DzScene::playbackFinished (  )  [signal]

Signature: "playbackFinished()"

Transmitted when playback of the scene stops.

void DzScene::playbackStarted (  )  [signal]

Signature: "playbackStarted()"

Transmitted when playback of the scene begins.

DzScene::playRangeChanged ( DzTimeRange  range  )  [signal]

Signature: "playRangeChanged(const DzTimeRange&)"

Transmitted after the scene play range is changed.

Parameters:
range The new play range of the scene

DzScene::primarySelectionChanged ( DzNode  node  )  [signal]

Signature: "primarySelectionChanged(DzNode*)"

Transmitted when the primary node selection changes.

Parameters:
node The new primary selection of the scene

void DzScene::removeAllCameras (  ) 

Removes all cameras from the scene.

void DzScene::removeAllLights (  ) 

Removes all lights from the scene.

DzError DzScene::removeDataItem ( DzSceneData  item  ) 

Removes the scene data item from the scene.

Parameters:
item The data item to remove from the scene.
Returns:
DZ_NO_ERROR if the item was successfully removed, otherwise an error code.

Boolean DzScene::removeNode ( DzNode  node  ) 

Removes the given node from the scene.

Parameters:
node The node to remove from the scene.
Returns:
true if the node was successfully removed, or false if it is not in the scene or cannot be removed.

void DzScene::removeSelected (  ) 

Removes all nodes that have items in their hierarchy that are currently selected.

DzError DzScene::removeWSModifier ( DzWSModifier  modifier  ) 

Removes the modifier from the scene's modifier stack if it exists

Parameters:
modifier Pointer to the World-Space Modifier to remove from the scene.
Returns:
DZ_NO_ERROR on success, otherwise an error code.

DzScene::renderFinished ( DzRenderer  renderer  )  [signal]

Signature: "renderFinished(DzRenderer*)"

Emitted just after the scene is rendered

Parameters:
renderer A pointer to the renderer that rendered the scene

DzError DzScene::saveScene ( String  filename = ""  ) 

Save the entire scene.

Parameters:
filename The file to save the scene to. If empty, the scene will be saved to the filename that it was last saved to, if any. If no prior file name exists, DZ_ILLEGAL_ARGUMENT_ERROR is returned. If a filename is passed, it becomes the save filename that will be used for future saves. If the file cannot be opened or saved, DZ_OPERATION_FAILED_ERROR is returned.
Returns:
DZ_NO_ERROR on success, otherwise an error code.

void DzScene::saveThumbnail ( String  filename  ) 

Saves a thumbnail-size OpenGL render of the current viewport to the given file name.

Parameters:
filename The filename to save the thumbnail to. This should have an extension that is supported by the image manager.

void DzScene::sceneCleared (  )  [signal]

Signature: "sceneCleared()"

Transmitted after the scene gets cleared.

void DzScene::sceneClearStarting (  )  [signal]

Signature: "sceneClearStarting()"

Emitted just before the scene is cleared.

DzScene::sceneFilenameChanged ( String  newName  )  [signal]

Signature: "sceneFilenameChanged(const QString&)"

Transmitted when the name of the current scene file has changed

void DzScene::sceneLoaded (  )  [signal]

Signature: "sceneLoaded()"

Transmitted after loading a scene file. This may not always be emitted after every sceneLoadStarting() signal if there were errors during file loading.

void DzScene::sceneLoadStarting (  )  [signal]

Signature: "sceneLoadStarting()"

Transmitted just before loading a scene.

void DzScene::selectAllNodes ( Boolean  onOff  ) 

Sets the selection state for all Nodes in the scene.

Parameters:
onOff If true all nodes in the scene will be selected. If false, all nodes will be deselected.

void DzScene::selectAllSkeletons ( Boolean  onOff  ) 

Sets the selection state for all Skeletons in the scene.

Parameters:
onOff If true all skeletons in the scene will be selected. If false, all skeletons will be deselected.

void DzScene::selectAllTime ( Boolean  onOff  ) 

Selects/Deselects all time range

Parameters:
onOff If true, all ranges are selected. If false, all are deselected.

void DzScene::setAnimRange ( DzTimeRange  range  ) 

Sets the Animation range for the scene

Parameters:
range The time range to set for the entire animation
See also:
getAnimRange()

void DzScene::setAudio ( DzAudioClip  audio,
Number  startFrame = 0 
)

Sets the current audio object and the frame on which it should start playing.

Parameters:
audio A pointer to the new audio clip for the scene. Pass in NULL to clear the current audio clip.
startFrame The frame at which the audio should begin playing.
See also:
getAudio()

void DzScene::setBackdrop ( DzBackdrop  backdrop  ) 

Sets the backdrop object.

Parameters:
backdrop A pointer to the new backdrop for the scene. The scene takes ownership of this object and deletes it when it is no longer needed.
See also:
getBackdrop()

void DzScene::setFrame ( Number  frame  ) 

Set the Scene time to the given frame based on current time step.

Parameters:
frame Frame which the current Scene time will be set to the begining of.
See also:
getFrame()

void DzScene::setHighlightNode ( DzNode  node  ) 

Sets the currently highlighted node. This is typically called from DzViewTool-derived classes.

Parameters:
node The node that will become the currently highlighted node.

void DzScene::setPlayRange ( DzTimeRange  range  ) 

Sets the Play range for the scene

Parameters:
range The time range to set for animation playback.
See also:
getPlayRange()

void DzScene::setPrimarySelection ( DzNode  node  ) 

Sets the node to use as the primary selection.

Parameters:
which Pointer to a selected node that should be flagged as the primary selection. The node must already be selected.
Returns:
true if the node was made the new primary selection, otherwise false.

void DzScene::setTime ( DzTime  time  ) 

Set the Scene time to the given time

Parameters:
time Time which will become the current Scene time.
See also:
getTime()

void DzScene::setTimeStep ( DzTime  tm  ) 

Sets the Frame rate for the scene

Parameters:
time Number of time clicks per frame.
See also:
getTimeStep()

DzScene::skeletonAdded ( DzSkeleton  node  )  [signal]

Signature: "skeletonAdded(DzSkeleton*)"

Transmitted when skeletons are added to the scene.

Parameters:
node The skeleton added to the scene

void DzScene::skeletonListChanged (  )  [signal]

Signature: "skeletonListChanged()"

Transmitted when skeletons are added to or removed from the scene.

DzScene::skeletonRemoved ( DzSkeleton  node  )  [signal]

Signature: "skeletonRemoved(DzSkeleton*)"

Transmitted when skeletons are removed from the scene.

Parameters:
node The skeleton removed from the scene

void DzScene::skeletonSelectionListChanged (  )  [signal]

Signature: "skeletonSelectionListChanged()"

Transmitted after the skeleton selection list changes.

void DzScene::stepTime ( Number  nFrames = 1,
Boolean  forward = true 
)

Step time forward/back by number of frames

Parameters:
nFrames Number of frames to step from the current position.
forward If true, current frame count is increased nFrames. If false, current frame count is decreased.

void DzScene::timeChanged ( DzTime  time  )  [signal]

Signature: "timeChanged(DzTime)"

Transmitted after the scene time is changed.

Parameters:
time The new time of the scene

void DzScene::timeChanging ( DzTime  newTime  )  [signal]

Signature: "timeChanging(DzTime)"

Transmitted when time is about to change.

Parameters:
newTime The new time of the scene

void DzScene::timeSelectionChanged (  )  [signal]

Signature: "timeSelectionChanged()"

Transmitted after the scene time selection is changed.

void DzScene::timeStepChanged ( DzTime  time  )  [signal]

Signature: "timeStepChanged(DzTime)"

Transmitted after the scene time step is changed.

Parameters:
time The new time step of the scene

void DzScene::update (  ) 

Recursively updates all nodes in the scene.

DzScene::wsModifierAdded ( DzWSModifier  modifier  )  [signal]

Signature: "wsModifierAdded(DzWSModifier*)"

Transmitted when world-space modifiers are added to the scene.

Parameters:
modifier The modifier added to the scene

DzScene::wsModifierRemoved ( DzWSModifier  modifier  )  [signal]

Signature: "wsModifierRemoved(DzWSModifier*)"

Transmitted when world-space modifiers are removed from the scene.

Parameters:
modifier The modifier removed from the scene

void DzScene::wsModifierStackChanged (  )  [signal]

Signature: "wsModifierStackChanged()"

Transmitted when world-space modifiers are added to or removed from the scene.


Generated on Thu Sep 24 12:21:15 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.