kfbxproperty.h File Reference

#include <fbxfilesdk/fbxfilesdk_def.h>
#include <fbxfilesdk/kfbxplugins/kfbxplug.h>
#include <fbxfilesdk/kfbxplugins/kfbxtypes.h>
#include <fbxfilesdk/components/kfcurve/kfcurvenode.h>
#include <fbxfilesdk/kfbxplugins/kfbxdatatypes.h>
#include <fbxfilesdk/fbxcore/kfbxpropertydef.h>
#include <fbxfilesdk/components/kbaselib/klib/kmap.h>
#include <fbxfilesdk/fbxfilesdk_nsbegin.h>
#include <fbxfilesdk/fbxfilesdk_nsend.h>

Go to the source code of this file.

Classes
class	KFbxProperty
	Class to hold user properties. More...
struct	KFbxProperty::KFbxPropertyNameCache
	This is an internal structure that you can use to build and clear the name map of properties. You can use the name map to speed up searching for property names. More...
class	KFbxTypedProperty< T >
	This template class is used to contain user properties of specific data types. More...
class	KFbxTypedProperty< fbxReference * >
	This template class is specialized using the pointer of class fbxReference to hold user properties whose data type are fbxReference. More...
class	KFbxConnectEvent
	Class handles Connection events. More...
Typedefs
typedef KFbxProperty *	HKFbxProperty
typedef KFbxTypedProperty < fbxBool1 >	KFbxPropertyBool1
typedef KFbxTypedProperty < fbxInteger1 >	KFbxPropertyInteger1
typedef KFbxTypedProperty < fbxDouble1 >	KFbxPropertyDouble1
typedef KFbxTypedProperty < fbxDouble3 >	KFbxPropertyDouble3
typedef KFbxTypedProperty < fbxDouble4 >	KFbxPropertyDouble4
typedef KFbxTypedProperty < fbxString >	KFbxPropertyString
typedef KFbxTypedProperty < fbxReference * >	KFbxPropertyReference
Enumerations
enum	eFbxConnectEventType {   eFbxConnectRequest, eFbxConnect, eFbxConnected, eFbxDisconnectRequest,   eFbxDisconnect, eFbxDisconnected }
	Connection event type. More...
enum	eFbxConnectEventDirection { eConnectEventSrc, eConnectEventDst }
	Connection event direction. More...
Functions
template<class T >
bool	KFbxSet (KFbxProperty &pProperty, T const &pValue, bool pCheckValueEquality=true)
template<class T >
bool	KFbxGet (KFbxProperty const &pProperty, T &pValue)
template<class T >
T	KFbxGet (KFbxProperty const &pProperty)

---

Detailed Description

Definition in file kfbxproperty.h.

---

Typedef Documentation

typedef KFbxProperty* HKFbxProperty

Search for all occurrences

Definition at line 1257 of file kfbxproperty.h.

typedef KFbxTypedProperty<fbxBool1> KFbxPropertyBool1

Search for all occurrences

Definition at line 1567 of file kfbxproperty.h.

typedef KFbxTypedProperty<fbxInteger1> KFbxPropertyInteger1

Search for all occurrences

Definition at line 1568 of file kfbxproperty.h.

typedef KFbxTypedProperty<fbxDouble1> KFbxPropertyDouble1

Search for all occurrences

Definition at line 1569 of file kfbxproperty.h.

typedef KFbxTypedProperty<fbxDouble3> KFbxPropertyDouble3

Search for all occurrences

Definition at line 1570 of file kfbxproperty.h.

typedef KFbxTypedProperty<fbxDouble4> KFbxPropertyDouble4

Search for all occurrences

Definition at line 1571 of file kfbxproperty.h.

typedef KFbxTypedProperty<fbxString> KFbxPropertyString

Search for all occurrences

Definition at line 1572 of file kfbxproperty.h.

typedef KFbxTypedProperty<fbxReference*> KFbxPropertyReference

Search for all occurrences

Definition at line 1573 of file kfbxproperty.h.

---

Enumeration Type Documentation

enum eFbxConnectEventType

Search for all occurrences

Connection event type.

• eFbxConnectRequest
• eFbxConnect
• eFbxConnected
• eFbxDisconnectRequest
• eFbxDisconnect
• eFbxDisconnected

Enumerator:

eFbxConnectRequest	Search for all occurrences
eFbxConnect	Search for all occurrences
eFbxConnected	Search for all occurrences
eFbxDisconnectRequest	Search for all occurrences
eFbxDisconnect	Search for all occurrences
eFbxDisconnected	Search for all occurrences

Definition at line 1583 of file kfbxproperty.h.

                              {
        eFbxConnectRequest,
        eFbxConnect,
        eFbxConnected,
        eFbxDisconnectRequest,
        eFbxDisconnect,
        eFbxDisconnected
    };

enum eFbxConnectEventDirection

Search for all occurrences

Connection event direction.

• eConnectEventSrc
• eConnectEventDst

Enumerator:

eConnectEventSrc	Search for all occurrences
eConnectEventDst	Search for all occurrences

Definition at line 1596 of file kfbxproperty.h.

                                   {
        eConnectEventSrc,
        eConnectEventDst
    };

---

Function Documentation

bool KFbxSet	(	KFbxProperty &	pProperty,
		T const &	pValue,
		bool	pCheckValueEquality = true
	)		[inline]

Search for all occurrences

Definition at line 1259 of file kfbxproperty.h.

{ return pProperty.Set( &pValue,FbxTypeOf(pValue),pCheckValueEquality ); }

bool KFbxGet	(	KFbxProperty const &	pProperty,
		T &	pValue
	)		[inline]

Search for all occurrences

Examples:

ProceduralTexture/main.cxx.

Definition at line 1260 of file kfbxproperty.h.

{ return pProperty.Get( &pValue,FbxTypeOf(pValue) ); }

T KFbxGet

(

KFbxProperty const &

pProperty

)

[inline]

Search for all occurrences

Definition at line 1261 of file kfbxproperty.h.

{ T pValue; pProperty.Get( &pValue,FbxTypeOf(pValue) ); return pValue; }