KFbxConnectEvent Class Reference

Search for all occurrences

Detailed Description

Class handles Connection events.

Definition at line 1604 of file kfbxproperty.h.

#include <kfbxproperty.h>

List of all members.

Constructor and Destructor.

  KFbxConnectEvent (eFbxConnectEventType pType, eFbxConnectEventDirection pDir, KFbxProperty *pSrc, KFbxProperty *pDst)
  Constructor.

Data Access.

eFbxConnectEventType  GetType () const
  Returns the connection event type.
eFbxConnectEventDirection  GetDirection () const
  Returns the direction of connection event.
KFbxProperty GetSrc () const
  Returns the source property.
KFbxProperty GetDst () const
  Returns the destination property.
template<class T >
T *  GetSrcIfObject (T const *pFBX_TYPE) const
  Returns the object of the specified class type that contains the source property.
template<class T >
T *  GetDstIfObject (T const *pFBX_TYPE) const
  Returns the object of the specified class type that contains the destination property.

Constructor & Destructor Documentation

KFbxConnectEvent ( eFbxConnectEventType  pType,
eFbxConnectEventDirection  pDir,
KFbxProperty pSrc,
KFbxProperty pDst 
) [inline]

Constructor.

Parameters:
pType The connection event type.
pDir The direction of connection event.
pSrc The source property.
pDst The destination property.

Definition at line 1618 of file kfbxproperty.h.

                : mType(pType)
                , mDirection(pDir)
                , mSrc(pSrc)
                , mDst(pDst)
            {
            }

Member Function Documentation

eFbxConnectEventType GetType ( ) const [inline]

Returns the connection event type.

Definition at line 1634 of file kfbxproperty.h.

{ return mType; }
eFbxConnectEventDirection GetDirection ( ) const [inline]

Returns the direction of connection event.

Definition at line 1637 of file kfbxproperty.h.

{ return mDirection; }
KFbxProperty& GetSrc ( ) const [inline]

Returns the source property.

Definition at line 1640 of file kfbxproperty.h.

{ return *mSrc;  }
KFbxProperty& GetDst ( ) const [inline]

Returns the destination property.

Definition at line 1643 of file kfbxproperty.h.

{ return *mDst;  }
T* GetSrcIfObject ( T const *  pFBX_TYPE ) const [inline]

Returns the object of the specified class type that contains the source property.

Parameters:
pFBX_TYPE The specified class type.
Returns:
The object of the specified class type that contains the source property, NUll if this property is not a root property or no object of the specified class type contains this property.

Definition at line 1649 of file kfbxproperty.h.

{ return mSrc->IsRoot() ? KFbxCast<T>(mSrc->GetFbxObject()) : (T*)0; }
T* GetDstIfObject ( T const *  pFBX_TYPE ) const [inline]

Returns the object of the specified class type that contains the destination property.

Parameters:
pFBX_TYPE The specified class type.
Returns:
The object of the specified class type that contains the destination property, NUll if this property is not a root property or no object of the specified class type contains this property.

Definition at line 1655 of file kfbxproperty.h.

{ return mDst->IsRoot() ? KFbxCast<T>(mDst->GetFbxObject()) : (T*)0; }

The documentation for this class was generated from the following file:

KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent
KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent KFbxConnectEvent