Scene Fusion 2 API Reference
Public Types | Public Member Functions | List of all members
KS::SceneFusion2::sfSession Class Referenceabstract

#include <sfSession.h>

Inheritance diagram for KS::SceneFusion2::sfSession:

Public Types

typedef std::shared_ptr< sfSession > SPtr
 
typedef std::function< void(sfObject::SPtr objPtr, int childIndex)> CreateHandler
 
typedef std::function< void(sfObject::SPtr objPtr)> DeleteHandler
 
typedef std::function< void(sfObject::SPtr objPtr)> ConfirmDeleteHandler
 
typedef std::function< void(sfObject::SPtr objPtr)> LockHandler
 
typedef std::function< void(sfObject::SPtr objPtr)> UnlockHandler
 
typedef std::function< void(sfObject::SPtr objPtr)> LockOwnerChangeHandler
 
typedef std::function< void(sfObject::SPtr objPtr)> DirectLockChangeHandler
 
typedef std::function< void(sfDictionaryProperty::SPtr dictPtr, const sfName &key)> DictionaryRemoveHandler
 
typedef std::function< void(sfObject::SPtr objPtr, int childIndex)> ParentChangeHandler
 
typedef std::function< void(sfProperty::SPtr propertyPtr)> PropertyChangeHandler
 
typedef std::function< void(sfListProperty::SPtr listPtr, int index, int count)> ListAddHandler
 
typedef std::function< void(sfListProperty::SPtr listPtr, int index, int count)> ListRemoveHandler
 
typedef std::function< void(sfUser::SPtr userPtr)> UserJoinHandler
 
typedef std::function< void(sfUser::SPtr userPtr)> UserLeaveHandler
 
typedef std::function< void(sfUser::SPtr userPtr)> UserColorChangeHandler
 
typedef std::function< void(bool, sfObject::SPtr objPtr)> AcknowledgeSubscriptionHandler
 
typedef ksEvent< sfObject::SPtr & >::SPtr ObjectEventHandle
 
typedef ksEvent< sfObject::SPtr &, int & >::SPtr ObjectIndexEventHandle
 
typedef ksEvent< sfUser::SPtr & >::SPtr UserEventHandle
 
typedef ksEvent< sfProperty::SPtr & >::SPtr PropertyEventHandle
 
typedef ksEvent< sfListProperty::SPtr &, int &, int & >::SPtr ListPropertyEventHandle
 
typedef ksEvent< sfDictionaryProperty::SPtr &, sfName & >::SPtr DictionaryPropertyEventHandle
 
typedef ksEvent< bool &, sfObject::SPtr & >::SPtr AcknowledgeSubscriptionEventHandle
 

Public Member Functions

virtual ~sfSession ()
 
virtual ObjectIndexEventHandle RegisterOnCreateHandler (CreateHandler handler)=0
 
virtual void UnregisterOnCreateHandler (ObjectIndexEventHandle eventPtr)=0
 
virtual ObjectEventHandle RegisterOnDeleteHandler (DeleteHandler handler)=0
 
virtual void UnregisterOnDeleteHandler (ObjectEventHandle eventPtr)=0
 
virtual ObjectEventHandle RegisterOnConfirmDeleteHandler (ConfirmDeleteHandler handler)=0
 
virtual void UnregisterOnConfirmDeleteHandler (ObjectEventHandle eventPtr)=0
 
virtual ObjectEventHandle RegisterOnLockHandler (LockHandler handler)=0
 
virtual void UnregisterOnLockHandler (ObjectEventHandle eventPtr)=0
 
virtual ObjectEventHandle RegisterOnUnlockHandler (UnlockHandler handler)=0
 
virtual void UnregisterOnUnlockHandler (ObjectEventHandle eventPtr)=0
 
virtual ObjectEventHandle RegisterOnLockOwnerChangeHandler (LockOwnerChangeHandler handler)=0
 
virtual void UnregisterOnLockOwnerChangeHandler (ObjectEventHandle eventPtr)=0
 
virtual ObjectEventHandle RegisterOnDirectLockChangeHandler (DirectLockChangeHandler handler)=0
 
virtual void UnregisterOnDirectLockChangeHandler (ObjectEventHandle eventPtr)=0
 
virtual ObjectIndexEventHandle RegisterOnParentChangeHandler (ParentChangeHandler handler)=0
 
virtual void UnregisterOnParentChangeHandler (ObjectIndexEventHandle eventPtr)=0
 
virtual PropertyEventHandle RegisterOnPropertyChangeHandler (PropertyChangeHandler handler)=0
 
virtual void UnregisterOnPropertyChangeHandler (PropertyEventHandle eventPtr)=0
 
virtual DictionaryPropertyEventHandle RegisterOnDictionaryRemoveHandler (DictionaryRemoveHandler handler)=0
 
virtual void UnregisterOnDictionaryRemoveHandler (DictionaryPropertyEventHandle eventPtr)=0
 
virtual ListPropertyEventHandle RegisterOnListAddHandler (ListAddHandler handler)=0
 
virtual void UnregisterOnListAddHandler (ListPropertyEventHandle eventPtr)=0
 
virtual ListPropertyEventHandle RegisterOnListRemoveHandler (ListRemoveHandler handler)=0
 
virtual void UnregisterOnListRemoveHandler (ListPropertyEventHandle eventPtr)=0
 
virtual UserEventHandle RegisterOnUserJoinHandler (UserJoinHandler handler)=0
 
virtual void UnregisterOnUserJoinHandler (UserEventHandle eventPtr)=0
 
virtual UserEventHandle RegisterOnUserLeaveHandler (UserLeaveHandler handler)=0
 
virtual void UnregisterOnUserLeaveHandler (UserEventHandle eventPtr)=0
 
virtual UserEventHandle RegisterOnUserColorChangeHandler (UserColorChangeHandler handler)=0
 
virtual void UnregisterOnUserColorChangeHandler (UserEventHandle eventPtr)=0
 
virtual AcknowledgeSubscriptionEventHandle RegisterOnAcknowledgeSubscriptionHandler (AcknowledgeSubscriptionHandler handler)=0
 
virtual void UnregisterOnAcknowledgeSubscriptionHandler (AcknowledgeSubscriptionEventHandle eventPtr)=0
 
virtual bool IsConnected () const =0
 
virtual sfUser::SPtr LocalUser () const =0
 
virtual uint32_t LocalUserId ()=0
 
virtual bool EditsDisabled () const =0
 
virtual size_t NumObjects () const =0
 
virtual sfObject::SPtr GetObject (uint32_t id) const =0
 
virtual const std::list< sfObject::SPtr > & GetRootObjects () const =0
 
virtual sfUser::SPtr GetUser (uint32_t id) const =0
 
virtual const std::list< sfUser::SPtr > & GetUsers () const =0
 
virtual uint32_t GetObjectCount (const sfName &type) const =0
 
virtual uint32_t GetObjectLimit (const sfName &type) const =0
 
virtual std::vector< sfReferenceProperty::SPtr > GetReferences (sfObject::SPtr objPtr) const =0
 
virtual void Create (sfObject::SPtr objPtr)=0
 
virtual void Create (sfObject::SPtr objPtr, sfObject::SPtr parentPtr, int childIndex)=0
 
virtual void Create (std::list< sfObject::SPtr > &objectList)=0
 
virtual void Create (std::list< sfObject::SPtr > &objectList, sfObject::SPtr parentPtr, int childIndex)=0
 
virtual void Delete (sfObject::SPtr objPtr)=0
 
virtual uint32_t GetStringTableId (const sfName &str)=0
 
virtual sfName GetStringFromTable (uint32_t id)=0
 
virtual sfName TryGetStringFromTable (uint32_t id)=0
 
virtual void SetUserColor (float r, float g, float b)=0
 
virtual void SubscribeToChildren (sfObject::SPtr objPtr)=0
 
virtual void UnsubscribeFromChildren (sfObject::SPtr objPtr)=0
 

Detailed Description

Provides functions for accessing and manipulating synced objects and session data for a Scene Fusion session.

Member Typedef Documentation

◆ AcknowledgeSubscriptionEventHandle

typedef ksEvent<bool&, sfObject::SPtr&>::SPtr KS::SceneFusion2::sfSession::AcknowledgeSubscriptionEventHandle

Acknowledge subscription event.

Parameters
bool&isSubscription - if true, it was subscription. Otherwise, it was unsubscription.
sfObject::SPtr&- object

◆ AcknowledgeSubscriptionHandler

typedef std::function<void(bool, sfObject::SPtr objPtr)> KS::SceneFusion2::sfSession::AcknowledgeSubscriptionHandler

Acknowledge subscription event handler.

Parameters
boolisSubscription - if true, it was subscription. Otherwise, it was unsubscription.
sfObject::SPtr- parent of children that the user subscribed to

◆ ConfirmDeleteHandler

typedef std::function<void(sfObject::SPtr objPtr)> KS::SceneFusion2::sfSession::ConfirmDeleteHandler

Confirm delete event handler.

Parameters
sfObject::SPtr- object whose deletion was confirmed.

◆ CreateHandler

typedef std::function<void(sfObject::SPtr objPtr, int childIndex)> KS::SceneFusion2::sfSession::CreateHandler

Create event handler.

Parameters
sfObject::SPtr- object that was created.
int- child index the object was inserted at. -1 if this is a root object.

◆ DeleteHandler

typedef std::function<void(sfObject::SPtr objPtr)> KS::SceneFusion2::sfSession::DeleteHandler

Delete event handler.

Parameters
sfObject::SPtr- object that was deleted.

◆ DictionaryPropertyEventHandle

typedef ksEvent<sfDictionaryProperty::SPtr&, sfName&>::SPtr KS::SceneFusion2::sfSession::DictionaryPropertyEventHandle

Dictionary property event.

Parameters
sfDictionaryProperty::SPtr&- property
sfName&- key of the modified property

◆ DictionaryRemoveHandler

typedef std::function<void(sfDictionaryProperty::SPtr dictPtr, const sfName& key)> KS::SceneFusion2::sfSession::DictionaryRemoveHandler

Remove handler for a dictionary property.

Parameters
sfDictionaryProperty::SPtr- dict the field was removed from.
constsfName& - key of removed field.

◆ DirectLockChangeHandler

typedef std::function<void(sfObject::SPtr objPtr)> KS::SceneFusion2::sfSession::DirectLockChangeHandler

Direct lock change event handler.

Parameters
sfObject::SPtr- object whose direct lock owner changed.

◆ ListAddHandler

typedef std::function<void(sfListProperty::SPtr listPtr, int index, int count)> KS::SceneFusion2::sfSession::ListAddHandler

List add event handler.

Parameters
sfListProperty::SPtr- list that elements were added to.
int- index elements were inserted at.
int- count - number of elements added.

◆ ListPropertyEventHandle

typedef ksEvent<sfListProperty::SPtr&, int&, int&>::SPtr KS::SceneFusion2::sfSession::ListPropertyEventHandle

List property event.

Parameters
sfListProperty::SPtr&- property
int&- index of the first modified property
int&- number of modified properties

◆ ListRemoveHandler

typedef std::function<void(sfListProperty::SPtr listPtr, int index, int count)> KS::SceneFusion2::sfSession::ListRemoveHandler

List remove event handler.

Parameters
sfListProperty::SPtr- list that elements were removed from.
int- index elements were removed from.
int- count - number of elements removed.

◆ LockHandler

typedef std::function<void(sfObject::SPtr objPtr)> KS::SceneFusion2::sfSession::LockHandler

Lock event handler.

Parameters
sfObject::SPtr- object that became locked.

◆ LockOwnerChangeHandler

typedef std::function<void(sfObject::SPtr objPtr)> KS::SceneFusion2::sfSession::LockOwnerChangeHandler

Lock owner change event handler.

Parameters
sfObject::SPtr- object whose lock owner changed.

◆ ObjectEventHandle

typedef ksEvent<sfObject::SPtr&>::SPtr KS::SceneFusion2::sfSession::ObjectEventHandle

Object event.

Parameters
sfObject::SPtr&- object

◆ ObjectIndexEventHandle

typedef ksEvent<sfObject::SPtr&, int&>::SPtr KS::SceneFusion2::sfSession::ObjectIndexEventHandle

Object event that affected index in parent.

Parameters
sfObject::SPtr&- object
sfListProperty::SPtr&- index of object in its parent

◆ ParentChangeHandler

typedef std::function<void(sfObject::SPtr objPtr, int childIndex)> KS::SceneFusion2::sfSession::ParentChangeHandler

Parent change event handler.

Parameters
sfObject::SPtr- object whose parent changed.
int- childIndex of the object. -1 if the object has no parent.

◆ PropertyChangeHandler

typedef std::function<void(sfProperty::SPtr propertyPtr)> KS::SceneFusion2::sfSession::PropertyChangeHandler

Property change event handler.

Parameters
sfProperty::SPtr- property that changed.

◆ PropertyEventHandle

typedef ksEvent<sfProperty::SPtr&>::SPtr KS::SceneFusion2::sfSession::PropertyEventHandle

Property event.

Parameters
sfListProperty::SPtr&- property

◆ UnlockHandler

typedef std::function<void(sfObject::SPtr objPtr)> KS::SceneFusion2::sfSession::UnlockHandler

Unlock event handler.

Parameters
sfObject::SPtr- object that became unlocked.

◆ UserColorChangeHandler

typedef std::function<void(sfUser::SPtr userPtr)> KS::SceneFusion2::sfSession::UserColorChangeHandler

User color change event handler.

Parameters
sfUser::SPtr- user whose color changed.

◆ UserEventHandle

typedef ksEvent<sfUser::SPtr&>::SPtr KS::SceneFusion2::sfSession::UserEventHandle

User event.

Parameters
sfUser::SPtr&- user

◆ UserJoinHandler

typedef std::function<void(sfUser::SPtr userPtr)> KS::SceneFusion2::sfSession::UserJoinHandler

User join event handler.

Parameters
sfUser::SPtr- user who joined the session.

◆ UserLeaveHandler

typedef std::function<void(sfUser::SPtr userPtr)> KS::SceneFusion2::sfSession::UserLeaveHandler

User leave event handler.

Parameters
sfUser::SPtr- user who left the session.

Constructor & Destructor Documentation

◆ ~sfSession()

virtual KS::SceneFusion2::sfSession::~sfSession ( )
inlinevirtual

Destructor

Member Function Documentation

◆ Create() [1/4]

virtual void KS::SceneFusion2::sfSession::Create ( sfObject::SPtr  objPtr)
pure virtual

Sends a create request for an object and its descendants, and puts them in the syncing state. Does nothing if the object is already synced or locked, or not a root object.

Parameters
sfObject::SPtr- object to create.

◆ Create() [2/4]

virtual void KS::SceneFusion2::sfSession::Create ( sfObject::SPtr  objPtr,
sfObject::SPtr  parentPtr,
int  childIndex 
)
pure virtual

Sends a create request for an object and its descendants, puts them in the syncing state, and inserts the object as a child of a syncing parent. Does nothing if the object is already synced or locked, or not a root object.

Parameters
sfObject::SPtr- object to create.
sfObject::SPtr- parent to add obj to. Must be syncing.
int- child index to insert obj at.

◆ Create() [3/4]

virtual void KS::SceneFusion2::sfSession::Create ( std::list< sfObject::SPtr > &  objectList)
pure virtual

Sends a create request for a list of objects and their descendants, and puts them in the syncing state. Does not create objects that are already synced or locked, or not root objects. Objects that are not created will be set to null pointers.

Parameters
std::list<sfObject::SPtr>&- objects to create.

◆ Create() [4/4]

virtual void KS::SceneFusion2::sfSession::Create ( std::list< sfObject::SPtr > &  objectList,
sfObject::SPtr  parentPtr,
int  childIndex 
)
pure virtual

Sends a create request for a list of objects and their descendants, puts them in the syncing state, and inserts them as children of a syncing parent. Does not create objects that are already synced or locked, or not root objects. Objects that are not created will be set to null pointers.

Parameters
std::list<sfObject::SPtr>&- objects to create.
sfObject::SPtr- parent to add obj to. Must be syncing.
int- child index to insert objects at.

◆ Delete()

virtual void KS::SceneFusion2::sfSession::Delete ( sfObject::SPtr  objPtr)
pure virtual

Deletes an object and its descendants from the server and stops syncing it.

Parameters
sfObject::SPtr- object to delete.

◆ EditsDisabled()

virtual bool KS::SceneFusion2::sfSession::EditsDisabled ( ) const
pure virtual

If returns true, the local user cannot edit objects in this session. This is true while applying edits from other users.

Returns
bool

◆ GetObject()

virtual sfObject::SPtr KS::SceneFusion2::sfSession::GetObject ( uint32_t  id) const
pure virtual

Gets an object by id.

Parameters
uint32_t- id of object to get.
Returns
sfObject::SPtr - object with the given id, or null if none was found.

◆ GetObjectCount()

virtual uint32_t KS::SceneFusion2::sfSession::GetObjectCount ( const sfName &  type) const
pure virtual

Gets the number of objects of the given type, not including objects whose creation is pending.

Parameters
constsfName& type
Returns
uint32_t number of objects of the given type.

◆ GetObjectLimit()

virtual uint32_t KS::SceneFusion2::sfSession::GetObjectLimit ( const sfName &  type) const
pure virtual

Gets the maximum number of objects of the given type.

Parameters
constsfName& type.
Returns
uint32_t maximum number of objects of the given type. UINT32_MAX for unlimited.

◆ GetReferences()

virtual std::vector<sfReferenceProperty::SPtr> KS::SceneFusion2::sfSession::GetReferences ( sfObject::SPtr  objPtr) const
pure virtual

Gets all reference properties that reference the given object.

Parameters
sfObject::SPtrobjPtr to get references for.
Returns
std::vector<sfReferenceProperty::SPtr> references to the object. The first in each pair is the object containing the reference, and the second is the reference property.

◆ GetRootObjects()

virtual const std::list<sfObject::SPtr>& KS::SceneFusion2::sfSession::GetRootObjects ( ) const
pure virtual

Get a list of root objects. This list may not have the same order across clients.

Returns
const std::list<sfObject::SPtr>&

◆ GetStringFromTable()

virtual sfName KS::SceneFusion2::sfSession::GetStringFromTable ( uint32_t  id)
pure virtual

Gets a name string by id. The ids and names are shared across the session so any user can use the id to retrieve the same name. If the id is not in the table, logs an error and returns empty string.

Parameters
uint32_tid of name to get.
Returns
sfName name with the given id

◆ GetStringTableId()

virtual uint32_t KS::SceneFusion2::sfSession::GetStringTableId ( const sfName &  str)
pure virtual

Gets the id for a name string. The ids and names are shared across the session so any user can use the id to retrieve the same name.

Parameters
constsfName& str
Returns
uint32_t name id

◆ GetUser()

virtual sfUser::SPtr KS::SceneFusion2::sfSession::GetUser ( uint32_t  id) const
pure virtual

Gets a user by id.

Parameters
uint32_t- id of user to get.
Returns
sfUser::SPtr - with the given id, or null if none was found.

◆ GetUsers()

virtual const std::list<sfUser::SPtr>& KS::SceneFusion2::sfSession::GetUsers ( ) const
pure virtual

Get a list of connected users.

Returns
const std::list<sfUser::SPtr>&

◆ IsConnected()

virtual bool KS::SceneFusion2::sfSession::IsConnected ( ) const
pure virtual

Are we connected to the session?

Returns
bool

◆ LocalUser()

virtual sfUser::SPtr KS::SceneFusion2::sfSession::LocalUser ( ) const
pure virtual

The local user.

Returns
sfUser::SPtr

◆ LocalUserId()

virtual uint32_t KS::SceneFusion2::sfSession::LocalUserId ( )
pure virtual

The local user id.

Returns
uint32_t

◆ NumObjects()

virtual size_t KS::SceneFusion2::sfSession::NumObjects ( ) const
pure virtual

The number of objects in the session.

Returns
size_t

◆ RegisterOnAcknowledgeSubscriptionHandler()

virtual AcknowledgeSubscriptionEventHandle KS::SceneFusion2::sfSession::RegisterOnAcknowledgeSubscriptionHandler ( AcknowledgeSubscriptionHandler  handler)
pure virtual

Registers an on acknowledge subscription event handler that is invoked when the server acknowledges the children subscription.

Parameters
AcknowledgeSubscriptionHandler
Returns
AcknowledgeSubscriptionEventHandle

◆ RegisterOnConfirmDeleteHandler()

virtual ObjectEventHandle KS::SceneFusion2::sfSession::RegisterOnConfirmDeleteHandler ( ConfirmDeleteHandler  handler)
pure virtual

Registers an on confirm delete event handler that is invoked when an object deleted by the local user is confirmed as deleted by the server.

Parameters
ConfirmDeleteHandler
Returns
ObjectEventHandle

◆ RegisterOnCreateHandler()

virtual ObjectIndexEventHandle KS::SceneFusion2::sfSession::RegisterOnCreateHandler ( CreateHandler  handler)
pure virtual

Registers an on create event handler that is invoked when an object is created by another user, or when an object we attempted to delete could not be deleted. When an object with children is created, this is not invoked for the children.

Parameters
CreateHandler
Returns
ObjectIndexEventHandle

◆ RegisterOnDeleteHandler()

virtual ObjectEventHandle KS::SceneFusion2::sfSession::RegisterOnDeleteHandler ( DeleteHandler  handler)
pure virtual

Registers an on delete event handler that is invoked when an object is deleted by another user, or when an object we attempted to create could not be created. When an object with children is deleted, this is not invoked for the children.

Parameters
DeleteHandler
Returns
ObjectEventHandle

◆ RegisterOnDictionaryRemoveHandler()

virtual DictionaryPropertyEventHandle KS::SceneFusion2::sfSession::RegisterOnDictionaryRemoveHandler ( DictionaryRemoveHandler  handler)
pure virtual

Registers an on remove field event handler that is invoked when a field of a dictionary property is removed by another user, or when we attempt to set a new field on an object that becomes locked. The event is called before the field is removed.

Parameters
DictionaryRemoveHandler
Returns
DictionaryPropertyEventHandle

◆ RegisterOnDirectLockChangeHandler()

virtual ObjectEventHandle KS::SceneFusion2::sfSession::RegisterOnDirectLockChangeHandler ( DirectLockChangeHandler  handler)
pure virtual

Registers an on direct lock change event handler that is invoked when the direct lock owner changes.

Parameters
DirectLockChangeHandler
Returns
ObjectEventHandle

◆ RegisterOnListAddHandler()

virtual ListPropertyEventHandle KS::SceneFusion2::sfSession::RegisterOnListAddHandler ( ListAddHandler  handler)
pure virtual

Registers an on list add event handler that is invoked when one or more elements are added to a list property by another user, or when we attempt to remove elements on an object that becomes locked.

Parameters
ListAddHandler
Returns
ListPropertyEventHandle

◆ RegisterOnListRemoveHandler()

virtual ListPropertyEventHandle KS::SceneFusion2::sfSession::RegisterOnListRemoveHandler ( ListRemoveHandler  handler)
pure virtual

Registers an on list remove event handler that is invoked when one or more elements are removed from a list property by another user, or when we attempt to add elements on an object that becomes locked. The event is called before the elements are removed.

Parameters
ListRemoveHandler
Returns
ListPropertyEventHandle

◆ RegisterOnLockHandler()

virtual ObjectEventHandle KS::SceneFusion2::sfSession::RegisterOnLockHandler ( LockHandler  handler)
pure virtual

Registers an on lock event handler that is invoked when an object becomes locked by another user, directly or indirectly.

Parameters
LockHandler
Returns
ObjectEventHandle

◆ RegisterOnLockOwnerChangeHandler()

virtual ObjectEventHandle KS::SceneFusion2::sfSession::RegisterOnLockOwnerChangeHandler ( LockOwnerChangeHandler  handler)
pure virtual

Registers an on lock owner change event handler that is invoked when the lock owner on a locked object changes. If the lock owner is null, the object is partially locked. Partially locked objects can have their children edited, but are still locked indirectly by one or more descendant locks.

Parameters
LockOwnerChangeHandler
Returns
ObjectEventHandle

◆ RegisterOnParentChangeHandler()

virtual ObjectIndexEventHandle KS::SceneFusion2::sfSession::RegisterOnParentChangeHandler ( ParentChangeHandler  handler)
pure virtual

Registers an on parent change event handler that is invoked when an object's parent or child index is changed by another user, or when we attempt to change the parent or child index but could not because the child, old parent, or new parent became locked.

Parameters
ParentChangeHandler
Returns
ObjectIndexEventHandle

◆ RegisterOnPropertyChangeHandler()

virtual PropertyEventHandle KS::SceneFusion2::sfSession::RegisterOnPropertyChangeHandler ( PropertyChangeHandler  handler)
pure virtual

Registers an on property change event handler that is invoked when a property of an object is changed by another user, or when we attempted to change a property on an object that becomes locked.

Parameters
PropertyChangeHandler
Returns
PropertyEventHandle

◆ RegisterOnUnlockHandler()

virtual ObjectEventHandle KS::SceneFusion2::sfSession::RegisterOnUnlockHandler ( UnlockHandler  handler)
pure virtual

Registers an on unlock event handler that is invoked when an object locked by another user, directly or indirectly, becomes unlocked.

Parameters
UnlockHandler
Returns
ObjectEventHandle

◆ RegisterOnUserColorChangeHandler()

virtual UserEventHandle KS::SceneFusion2::sfSession::RegisterOnUserColorChangeHandler ( UserColorChangeHandler  handler)
pure virtual

Registers an on user color change event handler that is invoked when a user's color changes.

Parameters
UserColorChangeHandlerhandler
Returns
UserEventHandle

◆ RegisterOnUserJoinHandler()

virtual UserEventHandle KS::SceneFusion2::sfSession::RegisterOnUserJoinHandler ( UserJoinHandler  handler)
pure virtual

Registers an on user join event handler that is invoked when a user joins the session. Invoked once for each user already in the session when the local user connects.

Parameters
UserJoinHandler
Returns
UserEventHandle

◆ RegisterOnUserLeaveHandler()

virtual UserEventHandle KS::SceneFusion2::sfSession::RegisterOnUserLeaveHandler ( UserLeaveHandler  handler)
pure virtual

Registers an on user leave event handler that is invoked when a user leaves the session. Invoked once for each user in the session when the local user disconnects.

Parameters
UserLeaveHandler
Returns
UserEventHandle

◆ SetUserColor()

virtual void KS::SceneFusion2::sfSession::SetUserColor ( float  r,
float  g,
float  b 
)
pure virtual

Set a new color for the connected user.

Parameters
float- red value [0 to 1]
float- green value [0 to 1]
float- blue value [0 to 1]

◆ SubscribeToChildren()

virtual void KS::SceneFusion2::sfSession::SubscribeToChildren ( sfObject::SPtr  objPtr)
pure virtual

Subscribe to an object's children on the server.

Parameters
sfObject::SPtrobjPtr

◆ TryGetStringFromTable()

virtual sfName KS::SceneFusion2::sfSession::TryGetStringFromTable ( uint32_t  id)
pure virtual

Gets a name string by id. The ids and names are shared across the session so any user can use the id to retrieve the same name. If the id is not in the table, return an invalid sfName.

Parameters
uint32_tid of name to get.
Returns
sfName name with the given id

◆ UnregisterOnAcknowledgeSubscriptionHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnAcknowledgeSubscriptionHandler ( AcknowledgeSubscriptionEventHandle  eventPtr)
pure virtual

Unregisters an on acknowledge subscription event handler.

Parameters
AcknowledgeSubscriptionEventHandle

◆ UnregisterOnConfirmDeleteHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnConfirmDeleteHandler ( ObjectEventHandle  eventPtr)
pure virtual

Unregisters an on confirm delete event handler.

Parameters
ObjectEventHandle

◆ UnregisterOnCreateHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnCreateHandler ( ObjectIndexEventHandle  eventPtr)
pure virtual

Unregisters an on create event handler.

Parameters
ObjectIndexEventHandle

◆ UnregisterOnDeleteHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnDeleteHandler ( ObjectEventHandle  eventPtr)
pure virtual

Unregisters an on delete event handler.

Parameters
ObjectEventHandle

◆ UnregisterOnDictionaryRemoveHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnDictionaryRemoveHandler ( DictionaryPropertyEventHandle  eventPtr)
pure virtual

Unregisters an on remove field event handler.

Parameters
DictionaryPropertyEventHandle

◆ UnregisterOnDirectLockChangeHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnDirectLockChangeHandler ( ObjectEventHandle  eventPtr)
pure virtual

Unregisters an on direct lock change lock event handler.

Parameters
ObjectEventHandle

◆ UnregisterOnListAddHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnListAddHandler ( ListPropertyEventHandle  eventPtr)
pure virtual

Unregisters an on list add event handler.

Parameters
ListPropertyEventHandle

◆ UnregisterOnListRemoveHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnListRemoveHandler ( ListPropertyEventHandle  eventPtr)
pure virtual

Unregisters an on list remove event handler.

Parameters
ListPropertyEventHandleeventPtr to unregister.

◆ UnregisterOnLockHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnLockHandler ( ObjectEventHandle  eventPtr)
pure virtual

Unregisters an on lock event handler.

Parameters
ObjectEventHandle

◆ UnregisterOnLockOwnerChangeHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnLockOwnerChangeHandler ( ObjectEventHandle  eventPtr)
pure virtual

Unregisters an on lock owner change event handler.

Parameters
ObjectEventHandle

◆ UnregisterOnParentChangeHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnParentChangeHandler ( ObjectIndexEventHandle  eventPtr)
pure virtual

Unregisters an on parent change event handler.

Parameters
ObjectIndexEventHandle

◆ UnregisterOnPropertyChangeHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnPropertyChangeHandler ( PropertyEventHandle  eventPtr)
pure virtual

Unregisters an on property change event handler.

Parameters
PropertyEventHandle

◆ UnregisterOnUnlockHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnUnlockHandler ( ObjectEventHandle  eventPtr)
pure virtual

Unregisters an on unlock event handler.

Parameters
ObjectEventHandle

◆ UnregisterOnUserColorChangeHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnUserColorChangeHandler ( UserEventHandle  eventPtr)
pure virtual

Unregisters an on user color change event handler.

Parameters
UserEventHandleeventPtr to unregister.

◆ UnregisterOnUserJoinHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnUserJoinHandler ( UserEventHandle  eventPtr)
pure virtual

Unregisters an on user join event handler.

Parameters
UserEventHandle

◆ UnregisterOnUserLeaveHandler()

virtual void KS::SceneFusion2::sfSession::UnregisterOnUserLeaveHandler ( UserEventHandle  eventPtr)
pure virtual

Unregisters an on user leave event handler.

Parameters
UserEventHandle

◆ UnsubscribeFromChildren()

virtual void KS::SceneFusion2::sfSession::UnsubscribeFromChildren ( sfObject::SPtr  objPtr)
pure virtual

Unsubscribe from an object's children on the server.

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