kfbxreference.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_FBXREFERENCE_H
00005 #define FBXFILESDK_KFBXPLUGINS_FBXREFERENCE_H
00006 
00007 /**************************************************************************************
00008 
00009 Copyright (C) 2009 - 2010 Autodesk, Inc. and/or its licensors.
00010 All Rights Reserved.
00011 
00012 The coded instructions, statements, computer programs, and/or related material 
00013 (collectively the "Data") in these files contain unpublished information 
00014 proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015 Canada and United States of America federal copyright law and by international 
00016 treaties. 
00017 
00018 The Data may not be disclosed or distributed to third parties, in whole or in
00019 part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028 
00029 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038 OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 #include <fbxfilesdk/fbxfilesdk_def.h>
00042 
00043 #include <fbxfilesdk/kfbxplugins/kfbxobject.h>
00044 
00045 // FBX includes
00046 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00047 
00051 class KFBX_DLL KFbxReference : public KFbxObject
00052 {
00053     KFBXOBJECT_DECLARE(KFbxReference, KFbxObject);
00054 
00059 public:
00060 
00061     // Basic properties
00062     KFbxTypedProperty< KString >          ReferenceFilePath;
00063     KFbxTypedProperty< KString >          ReferenceNameSpace;
00064     KFbxTypedProperty< KString >          ReferenceNodeName;
00065 
00066     KFbxTypedProperty< int>               ReferenceDepth;
00067 
00068     KFbxTypedProperty< bool >             IsLoaded;
00069     KFbxTypedProperty< bool >             IsLocked;
00070     KFbxTypedProperty< bool >             IsOriginalProxy;
00071     KFbxTypedProperty< bool >             IsActiveProxy;
00072 
00073     // Proxy related properties;
00074     KFbxTypedProperty< KString >          ProxyManagerName;
00075     KFbxTypedProperty< KString >          ProxyTag;
00076 
00077 
00079     //  WARNING!
00080     //  Anything beyond these lines may not be documented accurately and is
00081     //  subject to change without notice.
00083 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00084 
00085     // Constructor / Destructor
00086 protected:
00087     KFbxReference(KFbxSdkManager& pManager, char const* pName);
00088     virtual bool ConstructProperties(bool pForceSet);
00089 
00090     virtual KString     GetTypeName() const;
00091     //Destructor
00092     virtual void Destruct(bool pRecursive, bool pDependents);
00093 
00094 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00095 
00096 };
00097 
00098 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00099 
00100 #endif // FBXFILESDK_KFBXPLUGINS_FBXREFERENCE_H
00101