treenode.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 TreeNode : virtual public Node
{
public:
    DECLARE_CLASS;

    TreeNode( void );
    ~TreeNode( void );
    virtual void Serialize( Stream &s );

    virtual void AddChild( TreeNode *pChild, bool bFirst = false ) const;
    virtual void RemoveChild( TreeNode *pChild ) const;
    virtual TreeNode *FirstChild( void ) const;
    virtual TreeNode *Parent( void ) const;
    virtual TreeNode *NextSibling( void ) const;
    virtual TreeNode *PrevSibling( void ) const;
    virtual void MoveChild( TreeNode *pChild, TreeNode *pAfter );

    virtual TreeNode *ChildByClass( const ClassDesc *pClass, bool bAutoCreate = true ) const;
    template < typename type >
    inline type *ChildByClass( bool bAutoCreate = true ) const { return dynamic_cast<type *>( ChildByClass( type::StaticClass(), bAutoCreate ) ); };
    virtual TreeNode *ChildByClass( const ClassDesc *pClass, unsigned int iIndex = 0 ) const;
    template < typename type >
    inline type *ChildByClass( unsigned int iIndex = 0 ) const { return dynamic_cast<type *>( ChildByClass( type::StaticClass(), iIndex ) ); };
    virtual void DeleteChildByClass( const ClassDesc *pClass );

    virtual QString Info( void ) const;
    virtual bool Visible( void ) const;
    virtual void SetVisible( bool b );
    virtual bool Locked( void ) const;
    virtual void SetLocked( bool b );
    virtual bool HiddenFromUI( void ) const;
    virtual void SetHiddenFromUI( bool b );

    virtual void OnLinked( const TreeNode *pOldParent );

    virtual void CheckValidity( Node::DiagnosticLevel iLevel  = dgnLevel2 ) const;

    QString UniqueChildName( 
        const TreeNode* pChild,         
        const QString& sPrefix = ""     
        ) const;

    virtual void SetStringID( const QString &sName );

    virtual void CopyTo( Node *pNode ) const;

private:
    mutable aptr<TreeNode> m_pNext;
    mutable aptr<TreeNode> m_pPrev;
    mutable aptr<TreeNode> m_pParent;
    mutable aptr<TreeNode> m_pChildren;
    abool m_bVisible, m_bLocked, m_bHiddenFromUI;
};

}; // end of namespace mudbox