1/****************************************************************************************
2
3 Copyright (C) 2015 Autodesk, Inc.
4 All rights reserved.
5
6 Use of this software is subject to the terms of the Autodesk license agreement
7 provided at the time of installation or download, or which otherwise accompanies
8 this software in either electronic or hard copy form.
9
10****************************************************************************************/
11
12//! \file fbxreference.h
13#ifndef _FBXSDK_SCENE_REFERENCE_H_
14#define _FBXSDK_SCENE_REFERENCE_H_
15
16#include <fbxsdk/fbxsdk_def.h>
17
18#include <fbxsdk/core/fbxobject.h>
19
20#include <fbxsdk/fbxsdk_nsbegin.h>
21
22/** Contains information about a referenced file.
23* \nosubgrouping
24*/
25class FBXSDK_DLL FbxSceneReference : public FbxObject
26{
27 FBXSDK_OBJECT_DECLARE(FbxSceneReference, FbxObject);
28
29public:
30 /// \name Basic properties
31 //@{
32 //! Path to the referenced file.
33 FbxPropertyT< FbxString > ReferenceFilePath;
34 //! Referenced file's namespace.
35 FbxPropertyT< FbxString > ReferenceNameSpace;
36 //! Referenced file's node name.
37 FbxPropertyT< FbxString > ReferenceNodeName;
38 //! Referenced file's node depth.
39 FbxPropertyT< FbxInt> ReferenceDepth;
40 //! \c True if referenced file is loaded.
41 FbxPropertyT< FbxBool > IsLoaded;
42 //! \c True if referenced file is locked.
43 FbxPropertyT< FbxBool > IsLocked;
44 //@}
45
46 /// \name Proxy related properties.
47 //@{
48 //! \c True if referenced file is the original proxy.
49 FbxPropertyT< FbxBool > IsOriginalProxy;
50
51 //! \c True if referenced file is active.
52 FbxPropertyT< FbxBool > IsActiveProxy;
53
54 //! The name of proxy manager where the referenced file's proxy can be found.
55 FbxPropertyT< FbxString > ProxyManagerName;
56 /** Referenced file's proxy tag.
57 * \remarks Proxy tags are unique names assigned to proxy references to more easily manage those references in Maya.
58 */
59 FbxPropertyT< FbxString > ProxyTag;
60 //@}
61
62/*****************************************************************************************************************************
63** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
64*****************************************************************************************************************************/
65#ifndef DOXYGEN_SHOULD_SKIP_THIS
66protected:
67 virtual void ConstructProperties(bool pForceSet);
68#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
69};
70
71#include <fbxsdk/fbxsdk_nsend.h>
72
73#endif /* _FBXSDK_SCENE_REFERENCE_H_ */
74