FBX C++ API Reference
Public Types | Public Member Functions | Static Public Member Functions
FbxConnectionPoint Class Reference

#include <fbxconnectionpoint.h>

Class Description

Definition at line 44 of file fbxconnectionpoint.h.

Public Types

enum  EDirection {
  eDirSrc = 1 << 0, eDirDst = 1 << 1, eDirUni = 1 << 2, eDirBoth = eDirSrc | eDirDst,
  eDirMask = eDirSrc | eDirDst | eDirUni
}
 
enum  EType { eStandard = 0, eSubConnection = 1 << 3, eTypeMask = eSubConnection }
 
enum  EAttribute { eDefault = 0, eCache = 1 << 4, eAttributeMask = eCache }
 
enum  EAllocFlag { eNotAllocated = 0, eAllocated = 1 << 5, eAllocFlagMask = eAllocated }
 
enum  ECleanedFlag { eNotCleaned = 0, eCleaned = 1 << 6, eCleanedFlagMask = eCleaned }
 
enum  EEvent {
  eSrcConnectRequest, eDstConnectRequest, eSrcConnect, eDstConnect,
  eSrcConnected, eDstConnected, eSrcDisconnect, eDstDisconnect,
  eSrcDisconnected, eDstDisconnected, eSrcReplaceBegin, eSrcReplaceEnd,
  eDstReplaceBegin, eDstReplaceEnd, eSrcReorder, eSrcReordered
}
 

Public Member Functions

 FbxConnectionPoint (void *pData=0)
 
virtual ~FbxConnectionPoint ()
 
void SetFilter (FbxConnectionPointFilter *pConnectFilter, EType pType=eStandard)
 
void InternalClear ()
 
void WipeConnectionList ()
 Clear the ConnectList without any regards to what is connected. More...
 
void Destroy ()
 
void SubConnectRemoveAll ()
 
FbxConnectionPoint * GetSubOwnerConnect ()
 
FbxConnectionPointFilter * GetFilter ()
 
virtual bool IsInReplace (FbxConnectionPoint *p1, FbxConnectionPoint *p2)
 
void SetConnectType (EType pType)
 
EType GetConnectType ()
 
void SetDirection (int pDirections)
 
EDirection GetDirection ()
 
void SetAttribute (int pAttributes)
 
EAttribute GetAttribute ()
 
void SetAllocatedFlag (bool pBool)
 
bool GetAllocatedFlag ()
 
void SetCleanedFlag (bool pBool)
 
bool GetCleanedFlag ()
 
bool IsValidSrc (FbxConnectionPoint *pConnect)
 
bool IsValidDst (FbxConnectionPoint *pConnect)
 
bool IsValidSrcConnection (FbxConnectionPoint *pConnect, FbxConnection::EType pConnectionType)
 
bool IsValidDstConnection (FbxConnectionPoint *pConnect, FbxConnection::EType pConnectionType)
 
bool RequestValidSrcConnection (FbxConnectionPoint *pConnect, FbxConnection::EType pConnectionType)
 
bool RequestValidDstConnection (FbxConnectionPoint *pConnect, FbxConnection::EType pConnectionType)
 
bool ConnectSrc (FbxConnectionPoint *pSrc, FbxConnection::EType pConnectionType=FbxConnection::eNone)
 
bool ConnectDst (FbxConnectionPoint *pDst, FbxConnection::EType pConnectionType=FbxConnection::eNone)
 
bool ConnectSrcAt (int pDst_SrcIndex, FbxConnectionPoint *pSrc, FbxConnection::EType pConnectionType=FbxConnection::eNone)
 
bool ConnectDstAt (int pSrc_DstIndex, FbxConnectionPoint *pDst, FbxConnection::EType pConnectionType=FbxConnection::eNone)
 
bool DisconnectDst (FbxConnectionPoint *pSrc)
 
bool DisconnectSrc (FbxConnectionPoint *pSrc)
 
void DisconnectAllSrc ()
 
void DisconnectAllDst ()
 
bool DisconnectDstAt (int pIndex)
 
bool DisconnectSrcAt (int pIndex)
 
bool ReplaceInDst (FbxConnectionPoint *pDstOld, FbxConnectionPoint *pDstNew, int pIndexInNew)
 
bool ReplaceInSrc (FbxConnectionPoint *pSrcOld, FbxConnectionPoint *pSrcNew, int pIndexInNew)
 
bool ReplaceDstAt (int pIndex, FbxConnectionPoint *pDst)
 
bool ReplaceSrcAt (int pIndex, FbxConnectionPoint *pSrc)
 
bool SwapSrc (int pIndexA, int pIndexB)
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Change the position of a source Connect. More...
 
bool MoveSrcAt (FbxConnectionPoint *pSrc, FbxConnectionPoint *pAtSrc)
 Change the position of a source Connect. More...
 
bool IsConnectedSrc (FbxConnectionPoint *)
 
bool IsConnectedDst (FbxConnectionPoint *)
 
bool IsConnected (FbxConnectionPoint *pConnect)
 
int GetSrcCount () const
 
FbxConnectionPoint * GetSrc (int pIndex) const
 
FbxConnection::EType GetSrcType (int pIndex) const
 
int GetDstCount () const
 
FbxConnectionPoint * GetDst (int pIndex) const
 
FbxConnection::EType GetDstType (int pIndex) const
 
int FindSrc (FbxConnectionPoint *pConnect)
 
int FindDst (FbxConnectionPoint *pConnect)
 
int GetSrcCount (FbxConnectionPointFilter *pFilter)
 
FbxConnectionPoint * GetSrc (int pIndex, FbxConnectionPointFilter *pFilter)
 
FbxConnection::EType GetSrcType (int pIndex, FbxConnectionPointFilter *pFilter)
 
int GetDstCount (FbxConnectionPointFilter *pFilter)
 
FbxConnectionPoint * GetDst (int pIndex, FbxConnectionPointFilter *pFilter)
 
FbxConnection::EType GetDstType (int pIndex, FbxConnectionPointFilter *pFilter)
 
void * GetData ()
 

Static Public Member Functions

static bool ConnectConnect (FbxConnectionPoint *pSrc, FbxConnectionPoint *pDst, FbxConnection::EType pConnectionType)
 
static bool ConnectAt (FbxConnectionPoint *pSrc, int pSrc_DstIndex, FbxConnectionPoint *pDst, int pDst_SrcIndex, FbxConnection::EType pConnectionType)
 
static bool DisconnectConnect (FbxConnectionPoint *pSrc, FbxConnectionPoint *pDst)
 

Member Enumeration Documentation

◆ EDirection

enum EDirection
Enumerator
eDirSrc 
eDirDst 
eDirUni 
eDirBoth 
eDirMask 

Definition at line 47 of file fbxconnectionpoint.h.

48  {
49  eDirSrc = 1 << 0, // Contains sources
50  eDirDst = 1 << 1, // Contains destinations
51  eDirUni = 1 << 2, // Connection is not 2 ways
52  eDirBoth = eDirSrc | eDirDst,
53  eDirMask = eDirSrc | eDirDst | eDirUni
54  };

◆ EType

enum EType
Enumerator
eStandard 
eSubConnection 
eTypeMask 

Definition at line 56 of file fbxconnectionpoint.h.

57  {
58  eStandard = 0,
59  eSubConnection = 1 << 3, // Connect is a sub Connect of another
60  eTypeMask = eSubConnection
61  };

◆ EAttribute

enum EAttribute
Enumerator
eDefault 
eCache 
eAttributeMask 

Definition at line 63 of file fbxconnectionpoint.h.

64  {
65  eDefault = 0,
66  eCache = 1 << 4,
67  eAttributeMask = eCache
68  };

◆ EAllocFlag

enum EAllocFlag
Enumerator
eNotAllocated 
eAllocated 
eAllocFlagMask 

Definition at line 70 of file fbxconnectionpoint.h.

71  {
72  eNotAllocated = 0,
73  eAllocated = 1 << 5,
74  eAllocFlagMask = eAllocated
75  };

◆ ECleanedFlag

enum ECleanedFlag
Enumerator
eNotCleaned 
eCleaned 
eCleanedFlagMask 

Definition at line 77 of file fbxconnectionpoint.h.

78  {
79  eNotCleaned = 0,
80  eCleaned = 1 << 6,
81  eCleanedFlagMask = eCleaned
82  };

◆ EEvent

enum EEvent
Enumerator
eSrcConnectRequest 
eDstConnectRequest 
eSrcConnect 
eDstConnect 
eSrcConnected 
eDstConnected 
eSrcDisconnect 
eDstDisconnect 
eSrcDisconnected 
eDstDisconnected 
eSrcReplaceBegin 
eSrcReplaceEnd 
eDstReplaceBegin 
eDstReplaceEnd 
eSrcReorder 
eSrcReordered 

Definition at line 84 of file fbxconnectionpoint.h.

85  {
86  eSrcConnectRequest,
87  eDstConnectRequest,
88  eSrcConnect,
89  eDstConnect,
90  eSrcConnected,
91  eDstConnected,
92  eSrcDisconnect,
93  eDstDisconnect,
94  eSrcDisconnected,
95  eDstDisconnected,
96  eSrcReplaceBegin,
97  eSrcReplaceEnd,
98  eDstReplaceBegin,
99  eDstReplaceEnd,
100  eSrcReorder,
101  eSrcReordered
102  };

Constructor & Destructor Documentation

◆ FbxConnectionPoint()

FbxConnectionPoint ( void *  pData = 0)

◆ ~FbxConnectionPoint()

virtual ~FbxConnectionPoint ( )
virtual

Member Function Documentation

◆ SetFilter()

void SetFilter ( FbxConnectionPointFilter *  pConnectFilter,
EType  pType = eStandard 
)

◆ InternalClear()

void InternalClear ( )

◆ WipeConnectionList()

void WipeConnectionList ( )

Clear the ConnectList without any regards to what is connected.

◆ Destroy()

void Destroy ( )

◆ SubConnectRemoveAll()

void SubConnectRemoveAll ( )

◆ GetSubOwnerConnect()

FbxConnectionPoint* GetSubOwnerConnect ( )
inline

Definition at line 116 of file fbxconnectionpoint.h.

116 { return GetConnectType() == eSubConnection ? mOwner : NULL; }
NULL
#define NULL
Definition: fbxarch.h:210

◆ GetFilter()

FbxConnectionPointFilter* GetFilter ( )
inline

Definition at line 117 of file fbxconnectionpoint.h.

117 { return mFilter; }

◆ IsInReplace()

virtual bool IsInReplace ( FbxConnectionPoint *  p1,
FbxConnectionPoint *  p2 
)
virtual

◆ SetConnectType()

void SetConnectType ( EType  pType)
inline

Definition at line 121 of file fbxconnectionpoint.h.

121 { mFlags = (mFlags & ~eTypeMask) | pType; }

◆ GetConnectType()

EType GetConnectType ( )
inline

Definition at line 122 of file fbxconnectionpoint.h.

122 { return EType(mFlags & eTypeMask); }

◆ SetDirection()

void SetDirection ( int  pDirections)
inline

Definition at line 123 of file fbxconnectionpoint.h.

123 { mFlags = (mFlags & ~eDirMask) | pDirections; }

◆ GetDirection()

EDirection GetDirection ( )
inline

Definition at line 124 of file fbxconnectionpoint.h.

124 { return EDirection(mFlags & eDirMask); }

◆ SetAttribute()

void SetAttribute ( int  pAttributes)
inline

Definition at line 125 of file fbxconnectionpoint.h.

125 { mFlags = (mFlags & ~eAttributeMask) | pAttributes; }

◆ GetAttribute()

EAttribute GetAttribute ( )
inline

Definition at line 126 of file fbxconnectionpoint.h.

126 { return EAttribute(mFlags & eAttributeMask); }

◆ SetAllocatedFlag()

void SetAllocatedFlag ( bool  pBool)
inline

Definition at line 127 of file fbxconnectionpoint.h.

127 { mFlags = ( pBool ) ? mFlags | eAllocated : mFlags & ~eAllocFlagMask; }

◆ GetAllocatedFlag()

bool GetAllocatedFlag ( )
inline

Definition at line 128 of file fbxconnectionpoint.h.

128 { return ( mFlags & eAllocFlagMask ) ? true : false; }

◆ SetCleanedFlag()

void SetCleanedFlag ( bool  pBool)
inline

Definition at line 129 of file fbxconnectionpoint.h.

129 { mFlags = ( pBool ) ? mFlags | eCleaned : mFlags & ~eCleanedFlagMask; }

◆ GetCleanedFlag()

bool GetCleanedFlag ( )
inline

Definition at line 130 of file fbxconnectionpoint.h.

130 { return ( mFlags & eCleanedFlagMask ) ? true : false; }

◆ IsValidSrc()

bool IsValidSrc ( FbxConnectionPoint *  pConnect)

◆ IsValidDst()

bool IsValidDst ( FbxConnectionPoint *  pConnect)

◆ IsValidSrcConnection()

bool IsValidSrcConnection ( FbxConnectionPoint *  pConnect,
FbxConnection::EType  pConnectionType 
)

◆ IsValidDstConnection()

bool IsValidDstConnection ( FbxConnectionPoint *  pConnect,
FbxConnection::EType  pConnectionType 
)

◆ RequestValidSrcConnection()

bool RequestValidSrcConnection ( FbxConnectionPoint *  pConnect,
FbxConnection::EType  pConnectionType 
)

◆ RequestValidDstConnection()

bool RequestValidDstConnection ( FbxConnectionPoint *  pConnect,
FbxConnection::EType  pConnectionType 
)

◆ ConnectSrc()

bool ConnectSrc ( FbxConnectionPoint *  pSrc,
FbxConnection::EType  pConnectionType = FbxConnection::eNone 
)

◆ ConnectDst()

bool ConnectDst ( FbxConnectionPoint *  pDst,
FbxConnection::EType  pConnectionType = FbxConnection::eNone 
)

◆ ConnectSrcAt()

bool ConnectSrcAt ( int  pDst_SrcIndex,
FbxConnectionPoint *  pSrc,
FbxConnection::EType  pConnectionType = FbxConnection::eNone 
)

◆ ConnectDstAt()

bool ConnectDstAt ( int  pSrc_DstIndex,
FbxConnectionPoint *  pDst,
FbxConnection::EType  pConnectionType = FbxConnection::eNone 
)

◆ ConnectConnect()

static bool ConnectConnect ( FbxConnectionPoint *  pSrc,
FbxConnectionPoint *  pDst,
FbxConnection::EType  pConnectionType 
)
static

◆ ConnectAt()

static bool ConnectAt ( FbxConnectionPoint *  pSrc,
int  pSrc_DstIndex,
FbxConnectionPoint *  pDst,
int  pDst_SrcIndex,
FbxConnection::EType  pConnectionType 
)
static

◆ DisconnectDst()

bool DisconnectDst ( FbxConnectionPoint *  pSrc)

◆ DisconnectSrc()

bool DisconnectSrc ( FbxConnectionPoint *  pSrc)

◆ DisconnectAllSrc()

void DisconnectAllSrc ( )

◆ DisconnectAllDst()

void DisconnectAllDst ( )

◆ DisconnectConnect()

static bool DisconnectConnect ( FbxConnectionPoint *  pSrc,
FbxConnectionPoint *  pDst 
)
static

◆ DisconnectDstAt()

bool DisconnectDstAt ( int  pIndex)

◆ DisconnectSrcAt()

bool DisconnectSrcAt ( int  pIndex)

◆ ReplaceInDst()

bool ReplaceInDst ( FbxConnectionPoint *  pDstOld,
FbxConnectionPoint *  pDstNew,
int  pIndexInNew 
)

◆ ReplaceInSrc()

bool ReplaceInSrc ( FbxConnectionPoint *  pSrcOld,
FbxConnectionPoint *  pSrcNew,
int  pIndexInNew 
)

◆ ReplaceDstAt()

bool ReplaceDstAt ( int  pIndex,
FbxConnectionPoint *  pDst 
)

◆ ReplaceSrcAt()

bool ReplaceSrcAt ( int  pIndex,
FbxConnectionPoint *  pSrc 
)

◆ SwapSrc()

bool SwapSrc ( int  pIndexA,
int  pIndexB 
)

◆ MoveSrcAt() [1/2]

bool MoveSrcAt ( int  pIndex,
int  pAtIndex 
)

Change the position of a source Connect.

Parameters
pIndexPosition of the Connect to move.
pAtIndexPosition where to move the Connect.
Returns
True if the Connect was moved.
Remarks
After the move, the Connect will be precisely at position pAtIndex.

◆ MoveSrcAt() [2/2]

bool MoveSrcAt ( FbxConnectionPoint *  pSrc,
FbxConnectionPoint *  pAtSrc 
)

Change the position of a source Connect.

Parameters
pSrcConnect to move.
pAtSrcConnect at which position to move.
Returns
True if the Connect was moved.
Remarks
After the move, the Connect will be precisely at the position where pAtSrc was before the move.

◆ IsConnectedSrc()

bool IsConnectedSrc ( FbxConnectionPoint *  )

◆ IsConnectedDst()

bool IsConnectedDst ( FbxConnectionPoint *  )

◆ IsConnected()

bool IsConnected ( FbxConnectionPoint *  pConnect)
inline

Definition at line 179 of file fbxconnectionpoint.h.

179 { return IsConnectedSrc(pConnect) || IsConnectedDst(pConnect); }
FbxConnectionPoint::IsConnectedSrc
bool IsConnectedSrc(FbxConnectionPoint *)
FbxConnectionPoint::IsConnectedDst
bool IsConnectedDst(FbxConnectionPoint *)

◆ GetSrcCount() [1/2]

int GetSrcCount ( ) const
inline

Definition at line 181 of file fbxconnectionpoint.h.

181 { return mConnectionList.GetSrcCount(); }

◆ GetSrc() [1/2]

FbxConnectionPoint* GetSrc ( int  pIndex) const
inline

Definition at line 182 of file fbxconnectionpoint.h.

182 { return mConnectionList.GetSrc(pIndex);}

◆ GetSrcType() [1/2]

FbxConnection::EType GetSrcType ( int  pIndex) const
inline

Definition at line 183 of file fbxconnectionpoint.h.

183 { return mConnectionList.GetSrcType(pIndex);}

◆ GetDstCount() [1/2]

int GetDstCount ( ) const
inline

Definition at line 184 of file fbxconnectionpoint.h.

184 { return mConnectionList.GetDstCount(); }

◆ GetDst() [1/2]

FbxConnectionPoint* GetDst ( int  pIndex) const
inline

Definition at line 185 of file fbxconnectionpoint.h.

185 { return mConnectionList.GetDst(pIndex);}

◆ GetDstType() [1/2]

FbxConnection::EType GetDstType ( int  pIndex) const
inline

Definition at line 186 of file fbxconnectionpoint.h.

186 { return mConnectionList.GetDstType(pIndex);}

◆ FindSrc()

int FindSrc ( FbxConnectionPoint *  pConnect)
inline

Definition at line 188 of file fbxconnectionpoint.h.

188 { return mConnectionList.FindSrc(pConnect); }

◆ FindDst()

int FindDst ( FbxConnectionPoint *  pConnect)
inline

Definition at line 189 of file fbxconnectionpoint.h.

189 { return mConnectionList.FindDst(pConnect); }

◆ GetSrcCount() [2/2]

int GetSrcCount ( FbxConnectionPointFilter *  pFilter)
inline

Definition at line 192 of file fbxconnectionpoint.h.

192 { return (pFilter) ? SubConnectGetOrCreate(pFilter)->GetSrcCount() : GetSrcCount(); }

◆ GetSrc() [2/2]

FbxConnectionPoint* GetSrc ( int  pIndex,
FbxConnectionPointFilter *  pFilter 
)
inline

Definition at line 193 of file fbxconnectionpoint.h.

193 { return (pFilter) ? SubConnectGetOrCreate(pFilter)->GetSrc(pIndex) : GetSrc(pIndex); }
FbxConnectionPoint::GetSrc
FbxConnectionPoint * GetSrc(int pIndex) const
Definition: fbxconnectionpoint.h:182

◆ GetSrcType() [2/2]

FbxConnection::EType GetSrcType ( int  pIndex,
FbxConnectionPointFilter *  pFilter 
)
inline

Definition at line 194 of file fbxconnectionpoint.h.

194 { return (pFilter) ? SubConnectGetOrCreate(pFilter)->GetSrcType(pIndex) : GetSrcType(pIndex); }
FbxConnectionPoint::GetSrcType
FbxConnection::EType GetSrcType(int pIndex) const
Definition: fbxconnectionpoint.h:183

◆ GetDstCount() [2/2]

int GetDstCount ( FbxConnectionPointFilter *  pFilter)
inline

Definition at line 195 of file fbxconnectionpoint.h.

195 { return (pFilter) ? SubConnectGetOrCreate(pFilter)->GetDstCount() : GetDstCount(); }

◆ GetDst() [2/2]

FbxConnectionPoint* GetDst ( int  pIndex,
FbxConnectionPointFilter *  pFilter 
)
inline

Definition at line 196 of file fbxconnectionpoint.h.

196 { return (pFilter) ? SubConnectGetOrCreate(pFilter)->GetDst(pIndex): GetDst(pIndex); }
FbxConnectionPoint::GetDst
FbxConnectionPoint * GetDst(int pIndex) const
Definition: fbxconnectionpoint.h:185

◆ GetDstType() [2/2]

FbxConnection::EType GetDstType ( int  pIndex,
FbxConnectionPointFilter *  pFilter 
)
inline

Definition at line 197 of file fbxconnectionpoint.h.

197 { return (pFilter) ? SubConnectGetOrCreate(pFilter)->GetDstType(pIndex) : GetDstType(pIndex); }
FbxConnectionPoint::GetDstType
FbxConnection::EType GetDstType(int pIndex) const
Definition: fbxconnectionpoint.h:186

◆ GetData()

void* GetData ( )
inline

Definition at line 199 of file fbxconnectionpoint.h.

199 { return mData; }
The documentation for this class was generated from the following file: