layer.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 2008 Autodesk, Inc.
// All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
//
//**************************************************************************/
// DESCRIPTION:
// CREATED: October 2008
//**************************************************************************/

namespace mudbox {

class MBDLL_DECL Layer : virtual public TreeNode
{
    DECLARE_CLASS;

public:
    virtual float Transparency( void ) const;
    
    virtual void SetTransparency(
        float fTransparency     
        );

    virtual Layer *Children( void ) const;
    
    virtual Layer *Next( void ) const;
    
    virtual Layer *Prev( void ) const;
    
    virtual class LayerContainer *Container( void ) const;
};

class MBDLL_DECL LayerContainer : virtual public TreeNode
{
    DECLARE_CLASS;

public:
    virtual unsigned int LayerCount( void ) const;
    
    virtual class Layer *Layer(
        unsigned int iLayerIndex    
        ) const;
        
    virtual unsigned int LayerIndex(
        const class Layer *pLayer           
        ) const;
    
    virtual void UnlinkLayer(
        class Layer *pLayer     
        );
    
    virtual void AddLayer(
        class Layer *pLayer     
        );
    
    virtual class Layer *CreateLayer( void );
    
    virtual class Layer *ActiveLayer( void ) const;
    
    virtual void SetActiveLayer(
        class Layer *pLayer     
        );
        
    virtual void MoveLayer(
        class Layer *pLayer,    
        class Layer *pWhere,    
        bool bBefore            
        );
    
    virtual void ReparentLayer(
        class Layer *pLayer,    
        class Layer *pParent    
        );
    
    virtual class Layer *BaseLayer( void ) const;

    virtual unsigned int LayerGroupCount( void ) const;

    virtual class LayerGroup *LayerGroup( unsigned int iLayerGroupIndex ) const; 
    
    virtual class LayerGroup *LayerGroup( class Layer *pLayer ) const ;

    virtual class LayerGroup *AddLayerGroup( 
        const QString &sName    
        ); 

    virtual void AddLayerGroup(
        class LayerGroup *pLayerGroup       
        );

    virtual void RemoveLayerGroup(
        class LayerGroup *pLayerGroup 
        );
        
    virtual void UpdateLayerToGroup(
        class Layer *pLayer,    
        class LayerGroup *pLayerGroup 
        );
    
    virtual class LayerGroup *ActiveLayerGroup( void ) const;
 
    virtual void SetActiveLayerGroup(class LayerGroup *pLayerGroup) ;
        
    virtual void Serialize(
        Stream &s       
        );
};

class MBDLL_DECL LayerGroup : public Layer
{       
    DECLARE_CLASS;

protected:
    LayerGroup();

public:                        
    virtual LayerContainer *Container( void ) const; 
    
    virtual QString Name( void ) const;
    virtual void SetName(const QString &sName);
    virtual QString StringID( void ) const;
    virtual void SetStringID(const QString &sName);
    
    virtual bool Visible() const;

    virtual void SetVisible( bool bVisible );

    virtual float Transparency() const;

    virtual void SetTransparency( float fTransparency );

    virtual unsigned int LayerCount( void ) const;
    
    virtual class Layer *Layer(
        unsigned int iLayerIndex    
    ) const; 

    virtual QList<class Layer *> Layers( void ) const;

    virtual bool Contains(class Layer *pLayer) const;
}; 

class MBDLL_DECL LayerMeshData : public TreeNode
{
    DECLARE_CLASS;
public:
    virtual void SetName(
        const QString &sName        
        );

    virtual class Layer *Layer( void ) const;

    virtual QString Name( void ) const;
    
    virtual bool Visible() const;

    virtual void SetVisible( bool bVisible, bool bLeaveMesh = false );

    virtual mudbox::Mesh* Mesh() const;

    virtual void SetTransparency(
        float fTransparency,    
        bool bLeaveMesh = false 
        );

    virtual float Transparency( void ) const;

    virtual unsigned int LayerVertexIndex (
        unsigned int iVertexIndex,  
        bool bCreate = true     
        );
    
    virtual void SetVertexCount(
        unsigned int iVertexCount   
        );
    
    virtual unsigned int VertexCount() const;

    virtual unsigned int MeshVertexIndex( 
        unsigned int iLayerVertexIndex  
        ) const;

    virtual void SetVertexData( 
        unsigned int iVertexLayerIndex, 
        unsigned int iGlobalVertexIndex, 
        float fMask  
        );
        
    virtual Vector SetVertexDelta( 
        unsigned int iVertexLayerIndex, 
        unsigned int iGlobalVertexIndex, 
        const Vector &vDelta, 
        bool bUpdate = true 
    );
        
    virtual void SetVertexMask(
        unsigned int iVertexLayerIndex, 
        float fMask                     
        );
        
    virtual float VertexMask(
        unsigned int iVertexLayerIndex 
        );
        
    virtual Vector VertexDelta(
        unsigned int iVertexLayerIndex 
        );

    virtual bool FinishChanges();

    virtual void Transform( const Matrix &mMatrix );
};

}; // end of namespace mudbox