FBX SDK Reference Guide: kfbxnodeattribute.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_NODE_ATTRIBUTE_H_
00005 #define _FBXSDK_NODE_ATTRIBUTE_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright © 2001 - 2008 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 
00042 #include <kaydaradef.h>
00043 #ifndef KFBX_DLL 
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kaydara.h>
00048 #include <klib/karrayul.h>
00049 #include <klib/kstringlist.h>
00050 
00051 #ifndef MB_FBXSDK
00052 #include <kbaselib_nsuse.h>
00053 #endif
00054 
00055 #include <kfbxplugins/kfbxtakenodecontainer.h>
00056 
00057 #include <fbxfilesdk_nsbegin.h>
00058 
00059 class KFbxNode;
00060 class KFbxSdkManager;
00061 
00067 class KFBX_DLL KFbxNodeAttribute : public KFbxTakeNodeContainer
00068 {
00069     KFBXOBJECT_DECLARE(KFbxNodeAttribute,KFbxTakeNodeContainer);
00070 
00071 public:
00075     static const char*          sColor;
00076 
00080     static const fbxDouble3     sDefaultColor;
00081 
00083     //
00084     // Properties
00085     //
00087     
00092     KFbxTypedProperty<fbxDouble3>       Color;
00093 
00094 
00095 
00096     // Node attribute types.
00097     typedef enum 
00098     {   
00099         eUNIDENTIFIED,
00100         eNULL,
00101         eMARKER,
00102         eSKELETON, 
00103         eMESH, 
00104         eNURB, 
00105         ePATCH, 
00106         eCAMERA, 
00107         eCAMERA_SWITCHER,
00108         eLIGHT,
00109         eOPTICAL_REFERENCE,
00110         eOPTICAL_MARKER,
00111         eCONSTRAINT,
00112         eNURBS_CURVE,
00113         eTRIM_NURBS_SURFACE,
00114         eBOUNDARY,
00115         eNURBS_SURFACE,
00116         eSHAPE,
00117     } EAttributeType;
00118 
00122     virtual EAttributeType GetAttributeType() const { return eUNIDENTIFIED; }
00123 
00127     KFbxNode* GetNode() const;
00128 
00133 
00134 
00145     K_DEPRECATED void SetColor(KFbxColor const& pColor);
00146 
00158     K_DEPRECATED KFbxColor GetColor() const;
00159 
00161 
00162     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00163 
00165 //
00166 //  WARNING!
00167 //
00168 //  Anything beyond these lines may not be documented accurately and is 
00169 //  subject to change without notice.
00170 //
00172 
00173 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00174 
00175 public:
00176 
00177 protected:
00178     
00179     KFbxNodeAttribute(KFbxSdkManager& pManager, char const* pName);
00180     virtual ~KFbxNodeAttribute();
00181 
00182     virtual bool                    ConstructProperties(bool pForceSet);
00183 
00184     virtual KFbxTakeNodeContainer*  GetTakeNodeContainer();
00185 
00187     virtual void SetNode(KFbxNode& pNode);
00188     virtual void UnsetNode();
00189 
00190     virtual bool ConnecNotify (KFbxConnectEvent const &pEvent);
00191 
00195     virtual KString     GetTypeName() const;
00196     virtual KStringList GetTypeFlags() const;
00197 
00199     KFbxNodeAttribute& operator=(KFbxNodeAttribute const& pAttribute);
00200 
00201     KFbxNode*   mParentNode;
00202 
00203     friend class KFbxNode;
00204     friend class KFbxScene;
00205     friend class KFbxReaderFbx;
00206     friend class KFbxWriterFbx;
00207     friend class KFbxWriterFbx6;
00208     
00209 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00210 
00211 };
00212 
00213 typedef KFbxNodeAttribute* HKFbxNodeAttribute;
00214 
00215 #include <fbxfilesdk_nsend.h>
00216 
00217 #endif // #ifndef _FBXSDK_NODE_ATTRIBUTE_H_
00218 
00219