fbkeyinggroup.h

Go to the documentation of this file.

#ifndef __FBKEYINGGROUP_H__
#define __FBKEYINGGROUP_H__
/**************************************************************************
Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
All Rights Reserved.

The coded instructions, statements, computer programs, and/or related 
material (collectively the "Data") in these files contain unpublished 
information proprietary to Autodesk, Inc. and/or its licensors, which is 
protected by Canada and United States of America federal copyright law 
and by international treaties.

The Data may not be disclosed or distributed to third parties, in whole 
or in part, without the prior written consent of Autodesk, Inc. 
("Autodesk").

THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
FREE.

IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

#define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcomponent.h>

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {
#endif

    __FB_FORWARD( FBKeyingGroup );
    FB_DEFINE_COMPONENT( FBSDK_DLL, KeyingGroup );
    FB_DEFINE_LIST( FBSDK_DLL, KeyingGroup );

    enum FBKeyingGroupType {    
        kFBKeyingGroupGlobal,       
        kFBKeyingGroupObjectType,   
        kFBKeyingGroupLocal         
    };

    // FBKeyingGroup

    class FBSDK_DLL FBKeyingGroup : public FBComponent
    {
        //--- Open Reality declaration.
        __FBClassDeclare(FBKeyingGroup, FBComponent);
    public:

        FBKeyingGroup(const char* pName, FBKeyingGroupType pType, HIObject pObject=NULL);

        virtual void FBDelete();

        void SetObjectType(FBComponent* pObject);

        void AddProperty(FBProperty* pProp);
        void RemoveProperty(FBProperty* pProp); 

        FBProperty* GetProperty(int pIndex); 

        int GetPropertyCount();

        int FindPropertyIndex( FBProperty* pProp ); 

        void    AddObjectDependency(FBComponent* pObj);

        void    RemoveObjectDependency(FBComponent* pObj); 

        bool    IsObjectDependency(FBComponent* pObj);

        bool    IsObjectDependencySelected();

        void    RemoveAllProperties();
        void    RemoveAllObjectDependency();

        void    RemoveAllSubKeyingGroup();

        int                 GetParentKeyingGroupCount();
        FBKeyingGroup*      GetParentKeyingGroup(int pIndex);
        int                 GetSubKeyingGroupCount();
        FBKeyingGroup*      GetSubKeyingGroup(int pIndex);
        int                 GetSubObjectCount();
        FBComponent*        GetSubObject(int pIndex);

        int                 GetCumulativePropertyCount( bool pStopAtVisible = false );
        FBProperty*         GetCumulativeProperty( int pIndex, bool pStopAtVisible = false );

        void ClearAllItems();


        void SetEnabled(bool pEnable);

        void SetActive(bool pActive);

        void SetActiveAppend(bool pActive);

        static void DeselectAllAnimatableProperties();
    };

    // FBPropertyListKeyingGroup
    FB_DEFINE_LIST( FBSDK_DLL, KeyingGroup );
    FB_FORWARD( FBPropertyListKeyingGroup );

    class FBSDK_DLL FBPropertyListKeyingGroup : public FBPropertyListComponent
    {
    public:
        FBPropertyListKeyingGroup();
        FBKeyingGroup* operator[](int pIndex);
    };


#ifdef FBSDKUseNamespace
}
#endif
#endif /* this must be the last line of this file */