Foundry::Katana::Render::IdSenderInterface Class Reference

An interface for sending (ID, scene graph location name) pairs to Katana. This mapping is then used by the color picker to map a picked ID value in the monitor to the name of the corresponding scene graph location. More...

#include <IdSenderInterface.h>

Inheritance diagram for Foundry::Katana::Render::IdSenderInterface:

List of all members.

Public Member Functions
virtual void	getIds (int64_t *nextId, int64_t *maxId)=0
virtual void	send (uint64_t id, const char *const objectName)=0

---

Detailed Description

An interface for sending (ID, scene graph location name) pairs to Katana. This mapping is then used by the color picker to map a picked ID value in the monitor to the name of the corresponding scene graph location.

---

Member Function Documentation

virtual void Foundry::Katana::Render::IdSenderInterface::getIds	(	int64_t *	nextId,
		int64_t *	maxId
	)		[pure 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

Implemented in Foundry::Katana::Render::SocketIdSender.

virtual void Foundry::Katana::Render::IdSenderInterface::send	(	uint64_t	id,
		const char *const	objectName
	)		[pure 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

Implemented in Foundry::Katana::Render::SocketIdSender.

---

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

• IdSenderInterface.h