Foundry::Katana::Render::SocketIdSender Class Reference

Inheritance diagram for Foundry::Katana::Render::SocketIdSender:

List of all members.

Classes
class	SocketIdSenderException
Public Member Functions
void	getIds (int64_t *nextId, int64_t *maxId)
void	send (uint64_t id, const char *const objectName)

---

Member Function Documentation

void Foundry::Katana::Render::SocketIdSender::getIds	(	int64_t *	nextId,
		int64_t *	maxId
	)		[virtual]

Get the next unique ID integer value and the maximum number of IDs.

This function is now *deprecated* and shouldn't be called. For backwards compatibility, this function will still return the legacy values nextId = 1 and maxId = 1000000.

Now valid IDs range from 1 to 18446744073709551615. Value 0 is reserved.

Parameters:

nextId	A unique incremented ID value
maxId	The maximum number of ID values

Implements Foundry::Katana::Render::IdSenderInterface.

void Foundry::Katana::Render::SocketIdSender::send	(	uint64_t	id,
		const char *const	objectName
	)		[virtual]

Send an ID and scene graph location name pair for a rendered object to Katana.

Now valid IDs range from 1 to 18446744073709551615. Value 0 is reserved.

Parameters:

id	Unique ID
objectName	Scene graph location name

Implements Foundry::Katana::Render::IdSenderInterface.

---

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

• SocketIdSender.h