Foundry::Katana::NewFrameMessage Class Reference

The NewFrameMessage class encapsulates the message sent to the Katana Catalog Server (KCS) to specify that a new frame should be reserved in the Catalog. More...

#include <NewFrameMessage.h>

Inheritance diagram for Foundry::Katana::NewFrameMessage:

List of all members.

Public Member Functions
	NewFrameMessage (float frameTime=0.0, uint32_t height=0, uint32_t width=0, int xorigin=0, int yorigin=0)
	Create a new NewFrameMessage.
virtual	~NewFrameMessage ()
	Destroy the NewFrameMessage object.
int	setFrameName (const std::string &name)
	Set the human readable name that will appear in the name column of the Katana Catalog.
void	setFrameTime (float time)
	Set the frame time.
void	setFrameDimensions (uint32_t width, uint32_t height)
	Set the width and height of this frame.
void	setFrameOrigin (int ox, int oy)
	Set the origin of this frame.
const uint8_t *	frameUUID () const
	Get the unique identifier for this frame.

---

Detailed Description

The NewFrameMessage class encapsulates the message sent to the Katana Catalog Server (KCS) to specify that a new frame should be reserved in the Catalog.

The NewFrameMessage should be sent down the KatanaPipe first to reserve a frame in the Catalog. A frame may contain zero or more channels. Channels then contain the actual data output by the renderer.

A frame represents the collection of these channels at a point in time.

Each NewFrameMessage object will be created with a unique 128 bit identifier that will identify the frame being rendered to Katana.

---

Constructor & Destructor Documentation

Foundry::Katana::NewFrameMessage::NewFrameMessage	(	float	frameTime = 0.0,
		uint32_t	height = 0,
		uint32_t	width = 0,
		int	xorigin = 0,
		int	yorigin = 0
	)

Create a new NewFrameMessage.

The default constructor will create a NewFrameMessage object with a unique frame id and all other values initialised to 0.

The frame's name will be initialised to an empty string.

Parameters:

[in]	frameTime	the point in time this frame represents
[in]	height	the height in pixels of this frame
[in]	width	the width in pixels of this frame
[in]	xorigin	the xorigin relative to the lower left corner of the screen
[in]	yorigin	the yorigin relative to the lower left corner of the screen.

See also:

setFrameName()

---

Member Function Documentation

const uint8_t* Foundry::Katana::NewFrameMessage::frameUUID

(

)

const

Get the unique identifier for this frame.

Returns:

a pointer to the start of the 16 byte array that contains the unique frame ID.

void Foundry::Katana::NewFrameMessage::setFrameDimensions	(	uint32_t	width,
		uint32_t	height
	)

Set the width and height of this frame.

Parameters:

[in]	width	the width of this frame in pixels
[in]	height	the height of this frame in pixels

int Foundry::Katana::NewFrameMessage::setFrameName

(

const std::string &

name

)

Set the human readable name that will appear in the name column of the Katana Catalog.

The maximum number of characters that can be specified in name is 8000.

Parameters:

[in]

name

the name that will be sent to the KCS and appear in the Catalog

Returns:

0 if the name was set successfully, otherwise nonzero, if nonzero is returned the existing name will remain unchanged.

void Foundry::Katana::NewFrameMessage::setFrameOrigin	(	int	ox,
		int	oy
	)

Set the origin of this frame.

Parameters:

[in]	ox	the x origin relative to the lower left corner of the screen
[in]	oy	the y origin relative to the lower left corner of the screen.

void Foundry::Katana::NewFrameMessage::setFrameTime

(

float

time

)

Set the frame time.

Parameters:

[in]

time

the point in time this frame represents.

---

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

• NewFrameMessage.h