brushmask.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: November 2009
//**************************************************************************/

#ifndef __MUDBOXSDK_BRUSHMASK_H__
#define __MUDBOXSDK_BRUSHMASK_H__

namespace mudbox {

struct MBDLL_DECL BrushMask : public TreeNode
{
    Q_DECLARE_TR_FUNCTIONS(mudbox::BrushMask)
    DECLARE_CLASS;

    BrushMask( void );
    ~BrushMask( void );

    void SetState( bool b );
    bool State( void );

    float Factor( void );
    void SetFactor( float f );

    virtual void SetTransformation( const Matrix &mTransformation );
    Matrix Transformation( void );

    virtual class Image *Image( void );

    void SetImage( class Image *pImage );
    void Clear( void );
    void SetFileName( const QString &sFileName );
    virtual void CreateTextures( void );
    QString GetFileName() const { return m_sFileName; }


protected:
    Matrix        m_mTransformation;
    float         m_fAspectRatio;

    class Image  *m_pImage;
    Texture      *m_pLuminanceTexture;

    abool         m_bState;
    afloatr       m_fFactor;
    astring       m_sFileName;
};

struct MBDLL_DECL BrushStamp : public BrushMask
{
    DECLARE_CLASS;

    void SetParameters( const StampConfiguration  &config, 
                        const Vector              &vPosition, 
                        const Vector              &vNormal, 
                        float                     fSize, 
                        const Matrix             &mLocalToWorld );

    void CalculateTransformation( const Vector &vPosition, 
                                  const Vector &vNormal, 
                                  const Vector &vUp, 
                                  float fScaleX, float fScaleY, 
                                  bool  bFlip,   bool  bFlop, 
                                  const Matrix &mLocalToWorld );
};

struct MBDLL_DECL BrushStencil : public BrushMask
{
    enum
    {
        eColorModeUndefined = -1,
        eColorModeLuminance,
        eColorModeColored
    };

    DECLARE_CLASS;

    BrushStencil( void );
    ~BrushStencil( void );

    void SetVisibility( float f );
    float Visibility( void );

    void SetUIEnabled( bool b );

    void SetColorMode( unsigned int mode );
    unsigned int ColorMode( void );

    void SetOffset( float offset );
    float Offset( void ) const;

    void SetTransformation( const Matrix &mTransformation );
    void UpdateMatrix( void );
    const Matrix &Final( void ) const;
    Matrix MirroredFinal( void ) const;

    bool IsMirrored( void ) const;

    void SetInverted(bool inv) { m_bInvert.SetValue(inv); }

    bool IsInverted( void ) const;

    bool Activate( void );
    bool Deactivate( void );

    void SetFromImage( class Image *pSrcImage );

    virtual void CreateTextures( void );

    Texture *getTexture() const { return m_pColorTexture; }

    void SetFromColorTexture(Texture *pSrcTexture);

protected:
    bool          m_bUIEnabled;
    unsigned int  m_iColorMode;
    Matrix        m_mProjector;
    Matrix        m_mFinal;

    Texture      *m_pColorTexture;

    // attributes
    afloatr       m_fVisibility;
    abool         m_bInvert;
    abool         m_bUseTiles; 
    abool         m_bShowTiles;
    afloatr       m_fOffset;
    abool         m_bAutoHide;
    abool         m_bMirror;
    abool         m_bFlipX;
    abool         m_bFlipY;
                 
    aevent        m_cImport;
    aevent        m_cExport;
};

}; // end of namespace mudbox

#endif