The Scene class is the container object for all the data in a Mudbox scene.
All the geometry, lights, cameras, etc, are accessed and maintained through this object. To get a pointer to the current Mudbox scene, call Kernel()->Scene(). The scene class provides access to functions and events related to scene objects.
Definition at line 53 of file scene.h.
|
| virtual QStringList | SelectedObjectListNames (void) |
| |
| virtual mudbox::CurveBase * | ActiveCurve (void) const |
| | Returns a pointer to the curve that is currently active. More...
|
| |
| virtual void | SetActiveCurve (mudbox::CurveBase *curve) |
| | Sets a different curve to be active. More...
|
| |
| virtual mudbox::Camera * | ActiveCamera (void) const |
| | Returns a pointer to the camera that is currently being used. More...
|
| |
| virtual void | SetActiveCamera (mudbox::Camera *camera) |
| | Sets a different camera to be active. More...
|
| |
| virtual mudbox::Light * | ActiveLight (void) const |
| | Returns a pointer to the currently active light. More...
|
| |
| virtual void | SetActiveLight (mudbox::Light *light) |
| | Sets a different light to be active. More...
|
| |
| virtual unsigned int | CameraCount (void) const |
| | Returns the number of cameras in the scene. More...
|
| |
| virtual unsigned int | CurveCount (void) const |
| | Returns the number of Curve objects in the scene. More...
|
| |
| virtual unsigned int | SelectedCurveCount (void) const |
| | Returns the number of selected Curves. More...
|
| |
| virtual unsigned int | LightCount (void) const |
| | Returns the number of lights in the scene. More...
|
| |
| virtual unsigned int | GeometryCount (void) const |
| | Returns the number of Geometry objects in the scene. More...
|
| |
| virtual unsigned int | SelectedGeometryCount (void) const |
| | Returns the number of Geometry objects that are currently selected. More...
|
| |
| virtual mudbox::Camera * | AddCamera (mudbox::Camera *pCamera) |
| | Adds a camera to the scene. More...
|
| |
| virtual mudbox::Light * | AddLight (mudbox::Light *pLight) |
| | Adds a light to the scene. More...
|
| |
| virtual mudbox::CurveBase * | AddCurve (mudbox::CurveBase *pCurve, mudbox::Transformation *pTransformation=0) |
| | Adds a curve object to the scene. More...
|
| |
| virtual void | RemoveCurve (mudbox::CurveBase *pCurve) |
| | Removes a curve object from the scene. More...
|
| |
| virtual mudbox::Geometry * | AddGeometry (mudbox::Geometry *pGeometry, mudbox::Transformation *pTransformation=0) |
| | Adds a geometry object to the scene. More...
|
| |
| virtual void | RemoveGeometry (mudbox::Geometry *pGeometry) |
| | Removes a geometry object from the scene. More...
|
| |
| virtual mudbox::Camera * | Camera (unsigned int iIndex) const |
| | Returns a pointer to a Camera in the scene. More...
|
| |
| virtual mudbox::Light * | Light (unsigned int iIndex) const |
| | Returns a pointer to a Light in the scene. More...
|
| |
| virtual mudbox::CurveBase * | SelectedCurve (unsigned int iIndex) const |
| | Returns a pointer to a selected curve object in the scene. More...
|
| |
| virtual mudbox::CurveBase * | Curve (unsigned int iIndex) const |
| | Returns a pointer to a Curve object in the scene. More...
|
| |
| virtual mudbox::Geometry * | SelectedGeometry (unsigned int iIndex) const |
| | Returns a pointer to a selected Geometry object in the scene. More...
|
| |
| virtual mudbox::Geometry * | Geometry (unsigned int iIndex) const |
| | Returns a pointer to a Geometry object in the scene. More...
|
| |
| virtual AxisAlignedBoundingBox | BoundingBox (void) const |
| | Returns the bounding box of the scene. More...
|
| |
| virtual void | Render (bool bSkipMaterials=false) const |
| | Render the scene to the current render target using the current OpenGL pipeline settings. More...
|
| |
| virtual bool | Export (const QString &sFileName, bool bSelectedOnly=false) |
| | Export models in the scene to an OBJ file. Returns true if successful. More...
|
| |
| virtual bool | Load (QString sFileName, Scene::LoadData &cData) |
| | Load a MUD file into this scene. Returns true if successful. More...
|
| |
| virtual mudbox::Geometry * | Import (Scene::LoadData &cData, QString sFileName="") |
| | Imports data from a file, and returns a Mudbox geometry. More...
|
| |
| virtual bool | Save (QString sFileName) |
| | Save this scene. Returns true if successful. More...
|
| |
| mudbox::Geometry * | ActiveGeometry () const |
| | Returns a pointer to the active object (that is, the object whose layers are displayed in the UI) More...
|
| |
| void | SetActiveGeometry (mudbox::Geometry *geometry) const |
| | Sets the specified geometry to be active. This means that its layers will be displayed in the UI. This is unrelated to selection. More...
|
| |
| virtual void | SetActivePaintLayer (mudbox::Layer *layer) |
| | Sets the specified paint layer to be active. More...
|
| |
| virtual void | SetActivePaintLayerGroup (mudbox::LayerGroup *layergroup) |
| | Sets the specified paint layer group to be active. More...
|
| |
| virtual void | SetActiveTexture (mudbox::TexturePool *layer) |
| | Sets the layer associated with the active texture pool to be active. More...
|
| |
| virtual mudbox::Layer * | ActivePaintLayer () const |
| | Returns a pointer to the currently active paint layer. More...
|
| |
| virtual mudbox::LayerGroup * | ActivePaintLayerGroup () const |
| | Returns a pointer to the currently active paint layer group This returns NULL if a paint layer is currently active. More...
|
| |
| virtual mudbox::TexturePool * | ActiveTexture () const |
| | Returns a pointer to the currently active texture map. More...
|
| |
| virtual void | MakeThumbnail (QImage &image, int iSize=128) |
| | Creates a thumbnail of the current scene. More...
|
| |
| virtual QString | FileName () const |
| | Returns an absolute path to the scene's .mud file on disk, or an empty string if the scene has not been saved yet. More...
|
| |
| virtual bool | Dirty () const |
| | This indicates if the scene has been dirtied since the last time it was saved. More...
|
| |
| virtual void | SetDirty (bool bDirty=true) |
| | Sets the dirty status of the scene. More...
|
| |
| Mesh * | CreateMesh (Topology::FaceType eType) |
| | Creates an empty mesh object and returns a pointer to it. More...
|
| |
| | TreeNode (void) |
| |
| | ~TreeNode (void) |
| |
| virtual void | Serialize (Stream &s) |
| | Serializes the node. More...
|
| |
| virtual void | AddChild (TreeNode *pChild, bool bFirst=false) const |
| | Adds a node/subtree to the list of children. The added node will be removed from the current parent if it has one. More...
|
| |
| virtual void | RemoveChild (TreeNode *pChild) const |
| | Removes a node/subtree from the list of children. More...
|
| |
| virtual TreeNode * | FirstChild (void) const |
| | Returns the first node from the child list. More...
|
| |
| virtual TreeNode * | Parent (void) const |
| | Returns the parent node. More...
|
| |
| virtual TreeNode * | NextSibling (void) const |
| | Returns the next linked node with the same parent. More...
|
| |
| virtual TreeNode * | PrevSibling (void) const |
| | Returns the previous linked node with the same parent. More...
|
| |
| virtual void | MoveChild (TreeNode *pChild, TreeNode *pAfter) |
| | Moves the child after the given node in order. More...
|
| |
| virtual TreeNode * | ChildByClass (const ClassDesc *pClass, bool bAutoCreate=true) const |
| | Returns the first child with the specified type. When the bAutoCreate parameter is true and such a child does not exists, it creates it with the preferred descedant type. More...
|
| |
| template<typename type > |
| type * | ChildByClass (bool bAutoCreate=true) const |
| | Same as above, a most confortable version. More...
|
| |
| virtual TreeNode * | ChildByClass (const ClassDesc *pClass, unsigned int iIndex=0) const |
| | Returns the first child with the specified type, or returns zero if no child found. More...
|
| |
| template<typename type > |
| type * | ChildByClass (unsigned int iIndex=0) const |
| | Same as above, a most confortable version. More...
|
| |
| virtual void | DeleteChildByClass (const ClassDesc *pClass) |
| | Deletes all child which is derived from a specific class. More...
|
| |
| virtual QString | Info (void) const |
| | Returns descriptive information about the node. More...
|
| |
| virtual bool | Visible (void) const |
| | Returns if the node is visible. Should be overridden in derived classes. More...
|
| |
| virtual void | SetVisible (bool b) |
| | Sets the node visibility Should be overridden in derived classes. More...
|
| |
| virtual bool | Locked (void) const |
| | Returns if the node is locked. Should be overridden in derived classes. More...
|
| |
| virtual void | SetLocked (bool b) |
| | Sets the locking of the node. Should be overridden in derived classes. More...
|
| |
| virtual bool | HiddenFromUI (void) const |
| | Returns true if the node cannot be seen from UI. More...
|
| |
| virtual void | SetHiddenFromUI (bool b) |
| | Sets visibility in UI. More...
|
| |
| virtual void | OnLinked (const TreeNode *pOldParent) |
| | This function is called then the node is linked to a new parent. More...
|
| |
| virtual void | CheckValidity (Node::DiagnosticLevel iLevel=dgnLevel2) const |
| | See the documentation for Node::CheckValidity. More...
|
| |
| QString | UniqueChildName (const TreeNode *pChild, const QString &sPrefix="") const |
| | Finds a node name that is unique among the children of this node. More...
|
| |
| virtual void | SetStringID (const QString &sName) |
| | This method does the same thing as Node::SetStringID, except it ensures the name is unique among this node's siblings. More...
|
| |
| virtual void | CopyTo (Node *pNode) const |
| |
| | Node (const QString &sStringID="", const QString &sDisplayName="") |
| | Standard constructor. More...
|
| |
| virtual | ~Node (void) |
| |
| virtual void | Initialize (void) |
| |
| void | LoadTemplate (const QString &sFileName="", bool bStartEvent=false) |
| | Use an external XML file to initialize the attributes. More...
|
| |
| void | SaveTemplate (const QString &sFileName="", bool bSaveOnlyVisible=false) |
| | Save current attributes as an XML template. More...
|
| |
| unsigned int | Version (void) const |
| | Returns the current version of the node. This number increases when the content of the node changed (when ContentChanged() called). More...
|
| |
| void | SetVersion (unsigned int iVersion) |
| | Sets the current version number for the node. More...
|
| |
| unsigned int | ReferenceCount (void) const |
| | Returns the number of pointers referencing this node. More...
|
| |
| Attribute * | ReferencePointer (unsigned int iIndex) const |
| | Returns the address of an attribute which refers to this node. The type of the attribute is always aptr. More...
|
| |
| Node * | ReferenceNode (unsigned int iIndex) const |
| | Returns the address of a node referencing this node. More...
|
| |
| virtual QString | Name (const ClassDesc *pClass=0) const |
| | Deprecated. More...
|
| |
| virtual void | SetName (const QString &sName) |
| | Deprecated. More...
|
| |
| virtual QString | StringID (const ClassDesc *pClass=0) const |
| | Returns the string id of the node. More...
|
| |
| virtual QString | DisplayName (void) const |
| | Returns the display name of the node. More...
|
| |
| virtual void | SetDisplayName (const QString &sDisplayName) |
| | Sets the display name of the node. More...
|
| |
| virtual QString | HelpID (void) const |
| | Returns the help entry id of the node. Can be overwritten in derived classes. More...
|
| |
| virtual void | SetHelpID (const QString &sHelpID) |
| | Sets the help entry id of the node. More...
|
| |
| void | Annex (Node *pSource, const QString &sCategory="") |
| | Relink all the attributes of the source node to this one. More...
|
| |
| bool | IsKindOf (const ClassDesc *pClass) const |
| | Returns true if this node is derived from the pClass class. More...
|
| |
| void | ContentChanged (void) const |
| | This function must be called if the content of the node is changed. More...
|
| |
| virtual Node * | Duplicate (void) const |
| |
| virtual void | OnNodeEvent (const Attribute &cAttribute, NodeEventType cType) |
| | This function is called if an event occurs with any of the attributes of the node. More...
|
| |
| virtual void | OnEvent (const EventGate &cEvent) |
| | This function is called when a generic event occurs. See EventGate class. More...
|
| |
| void | RequestDeferredEvent (Attribute &cAttribute) |
| | Request for a deferred event, which will occur only in the main loop. More...
|
| |
| unsigned int | AttributeCount (void) const |
| | Returns the number of attributes owned by the node. More...
|
| |
| Attribute * | AttributeByIndex (int iIndex) const |
| | Returns a specified attribute (or 0 if iIndex is greater than the number of attributes). More...
|
| |
| Attribute * | AttributeByName (const QString &sName) const |
| | Returns a specified attribute by its name. Returns 0 if the attribute not found. More...
|
| |
| Attribute * | AttributeByID (const QString &sID) const |
| | Returns a specified attribute by its ID. Returns 0 if the attribute not found. More...
|
| |
| void | SetAttributeValue (const QString &sAttributeID, const QString &sNewValue) |
| | Set the value of an attribute from a string. More...
|
| |
| QString | AttributeValue (const QString &sAttributeID) const |
| | Returns the current value of an attribute as a string. More...
|
| |
| void | LogAttributes (void) const |
| | Write all attributes into the log file. More...
|
| |
| virtual QWidget * | CreatePropertiesWindow (QWidget *pParent) |
| | Create a window which displays the attributes of the node. Can be overriden to provide a custom interface. More...
|
| |
| Attribute * | AddAttribute (Attribute::AttributeType type, const QString &id) |
| | Allows SDK users to add attributes at runtime. More...
|
| |
| Node * | Next (void) const |
| | Returns the next node in the chain. Used to enumerate the current nodes. See also First(). More...
|
| |
| int | ID (void) const |
| | Returns an ID for the node. The ID is unique in the whole application life. More...
|
| |
| bool | SetID (int iID) |
| | Set ID for the node. More...
|
| |
Related help topics: 