fbxquery.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 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.
 
****************************************************************************************/

#ifndef _FBXSDK_CORE_QUERY_H_
#define _FBXSDK_CORE_QUERY_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxmap.h>
#include <fbxsdk/core/fbxpropertydef.h>
#include <fbxsdk/core/fbxproperty.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

#define FBXSDK_QUERY_UNIQUE_ID 0x14000000

class FbxQueryOperator;
class FbxQueryOperatorUnary;
class FbxQueryClassId;
class FbxQueryIsA;
class FbxQueryIsProperty;

class FBXSDK_DLL FbxQuery
{
public:
    FBXSDK_FRIEND_NEW();

    virtual FbxInt GetUniqueId() const { return FBXSDK_QUERY_UNIQUE_ID; }
    
    virtual bool IsValid(const FbxProperty& pProperty) const;

    virtual bool IsEqual(FbxQuery* pOtherQuery) const;

    void Ref();

    void Unref();

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    FbxQuery();
    virtual ~FbxQuery();

private:
    class InternalFilter : public FbxConnectionPointFilter
    {
    public:
        InternalFilter(FbxQuery* pQuery);
        ~InternalFilter();

    public:
        FbxConnectionPointFilter*   Ref();
        void                        Unref();
        FbxInt                      GetUniqueId() const { return mQuery->GetUniqueId(); }
        bool                        IsValid(FbxConnectionPoint* pConnect) const;
        bool                        IsEqual(FbxConnectionPointFilter* pConnectFilter) const;

        FbxQuery*                   mQuery;
    };

    InternalFilter  mFilter;
    int             mRefCount;

    friend class FbxProperty;
    friend class InternalFilter;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
};

class FBXSDK_DLL FbxCriteria
{
public:
    FBXSDK_FRIEND_NEW();

    FbxCriteria();

    FbxCriteria(const FbxCriteria& pCriteria);

    ~FbxCriteria();

    static FbxCriteria ObjectType(FbxClassId pClassId);

    static FbxCriteria ObjectIsA(FbxClassId pClassId);

    static FbxCriteria IsProperty();

    FbxCriteria& operator=(const FbxCriteria& pCriteria);

    FbxCriteria operator&&(const FbxCriteria& pCriteria) const;

    FbxCriteria operator||(const FbxCriteria& pCriteria) const;

    FbxCriteria operator!() const;

    FbxQuery* GetQuery() const;

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    FbxCriteria(FbxQuery* pQuery) : mQuery(pQuery)
    {
    }

private:
    FbxQuery* mQuery;

    static void FreeGlobalCache();

    class ClassIdCompare
    {
    public:
        inline int operator() (const FbxClassId& pKeyA, const FbxClassId& pKeyB) const
        {
            const FbxClassIdInfo* lKeyA = pKeyA.GetClassIdInfo();
            const FbxClassIdInfo* lKeyB = pKeyB.GetClassIdInfo();
            return (lKeyA > lKeyB) ? 1 : (lKeyA < lKeyB) ? -1 : 0;
        }
    };

    class ClassIdCache
    {
    public:
        ClassIdCache();
        ~ClassIdCache();

        FbxCriteria* GetObjectType(FbxClassId pClassId);
        static ClassIdCache* Get();
        static void Destroy();
        static FbxCriteria::ClassIdCache* mCache;

    private:
        typedef FbxMap<FbxClassId, FbxCriteria*, ClassIdCompare> CriteriaCacheMap;
        CriteriaCacheMap mObjectTypeCriteria;
    };

    friend class FbxManager;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
};

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
class FBXSDK_DLL FbxQueryOperator : public FbxQuery
{
public:
    FBXSDK_FRIEND_NEW();

    enum EType {eAND, eOR};

    static FbxQueryOperator* Create(FbxQuery* pA, EType pOperator, FbxQuery* pB);
    virtual FbxInt GetUniqueId() const { return FBXSDK_QUERY_UNIQUE_ID+1; }
    virtual bool IsValid(const FbxProperty& pProperty) const;
    virtual bool IsEqual(FbxQuery* pOtherQuery) const;

protected:
    FbxQueryOperator(FbxQuery* pA, EType pOperator, FbxQuery* pB);
    virtual ~FbxQueryOperator();

private:
    FbxQuery    *mA, *mB;
    EType       mOperator;
};

class FBXSDK_DLL FbxQueryOperatorUnary : public FbxQuery
{
public:
    FBXSDK_FRIEND_NEW();

    static FbxQueryOperatorUnary* Create(FbxQuery* pA);
    virtual FbxInt GetUniqueId() const{ return FBXSDK_QUERY_UNIQUE_ID+2; }
    virtual bool IsValid(const FbxProperty& pProperty) const;
    virtual bool IsEqual(FbxQuery* pOtherQuery) const;

protected:
    FbxQueryOperatorUnary(FbxQuery* pA);
    virtual ~FbxQueryOperatorUnary();

private:
    FbxQuery* mA;
};

class FBXSDK_DLL FbxQueryClassId : public FbxQuery
{
public:
    FBXSDK_FRIEND_NEW();

    static FbxQueryClassId* Create(FbxClassId pClassId);
    virtual FbxInt GetUniqueId() const{ return FBXSDK_QUERY_UNIQUE_ID+3; }
    virtual bool IsValid(const FbxProperty& pProperty) const;
    virtual bool IsEqual(FbxQuery* pOtherQuery) const;

protected:
    FbxQueryClassId(FbxClassId pClassId);

private:
    FbxClassId  mClassId;
};

class FBXSDK_DLL FbxQueryIsA : public FbxQuery
{
public:
    FBXSDK_FRIEND_NEW();

    static FbxQueryIsA* Create(FbxClassId pClassId);       
    virtual FbxInt GetUniqueId() const{ return FBXSDK_QUERY_UNIQUE_ID+4; }
    virtual bool IsValid(const FbxProperty& pProperty) const;
    virtual bool IsEqual(FbxQuery* pOtherQuery) const;

protected:
    FbxQueryIsA(FbxClassId pClassId);

private:
    FbxClassId mClassId;
};

class FBXSDK_DLL FbxQueryIsProperty : public FbxQuery
{
public:
    FBXSDK_FRIEND_NEW();

    static FbxQueryIsProperty* Create();
    virtual FbxInt GetUniqueId() const{ return FBXSDK_QUERY_UNIQUE_ID+5; }
    virtual bool IsValid(const FbxProperty& pProperty) const;
    virtual bool IsEqual(FbxQuery* pOtherQuery) const;

protected:
    FbxQueryIsProperty();
};
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_QUERY_H_ */