eq::server::FrameData Class Reference

A holder for a Frame Data and parameters. More...

#include <frameData.h>

Inheritance diagram for eq::server::FrameData:

Collaboration diagram for eq::server::FrameData:

List of all members.

Public Member Functions

FrameData ()

Constructs a new FrameData.

Data Access

void setFrameNumber (const uint32_t number)

Set the number of the frame when this data was last used.

uint32_t getFrameNumber () const

void setPixelViewport (const eq::PixelViewport &pvp)

Set the data's area within the channel.

void setOffset (const Vector2i &offset)

Set the position of the data relative to the window.

const Vector2i & getOffset () const

void setBuffers (const uint32_t buffers)

Set the (color, depth) buffers of the source frame.

uint32_t getBuffers () const

void setRange (const eq::Range &range)

Set the source range wrt dest channel.

void setPixel (const eq::Pixel &pixel)

Set the source pixel decomposition wrt dest channel.

void setZoom (const eq::Zoom &zoom)

Set the output frame zoom factor.

const eq::Zoom & getZoom () const

eq::Frame::Type getType () const

return the frame storage type.

void setType (const eq::Frame::Type type)

Set the frame storage type.

Protected Member Functions

virtual ChangeType getChangeType () const

virtual void getInstanceData (net::DataOStream &os)

Serialize the instance information about this managed object.

virtual void applyInstanceData (net::DataIStream &is)

Deserialize the instance data.

Friends

class Frame

Detailed Description

A holder for a Frame Data and parameters.

Definition at line 31 of file server/frameData.h.

Member Function Documentation

void eq::server::FrameData::setFrameNumber ( const uint32_t number ) [inline]

Set the number of the frame when this data was last used.

Definition at line 44 of file server/frameData.h.

Referenced by eq::server::Frame::cycleData().

Here is the caller graph for this function:

void eq::server::FrameData::setOffset ( const Vector2i & offset ) [inline]

Set the position of the data relative to the window.

Definition at line 52 of file server/frameData.h.

const Vector2i& eq::server::FrameData::getOffset ( ) const [inline]

Returns:: the position of the data relative to the window.

Definition at line 55 of file server/frameData.h.

Referenced by eq::server::CompoundUpdateInputVisitor::visit().

Here is the caller graph for this function:

void eq::server::FrameData::setBuffers ( const uint32_t buffers ) [inline]

Set the (color, depth) buffers of the source frame.

Definition at line 58 of file server/frameData.h.

void eq::server::FrameData::setRange ( const eq::Range & range ) [inline]

Set the source range wrt dest channel.

Definition at line 63 of file server/frameData.h.

void eq::server::FrameData::setPixel ( const eq::Pixel & pixel ) [inline]

Set the source pixel decomposition wrt dest channel.

Definition at line 67 of file server/frameData.h.

void eq::server::FrameData::setZoom ( const eq::Zoom & zoom ) [inline]

Set the output frame zoom factor.

Definition at line 71 of file server/frameData.h.

eq::Frame::Type eq::server::FrameData::getType ( ) const [inline]

return the frame storage type.

Definition at line 75 of file server/frameData.h.

void eq::server::FrameData::setType ( const eq::Frame::Type type ) [inline]

Set the frame storage type.

Parameters:

type

frame storage type.

Definition at line 82 of file server/frameData.h.

virtual ChangeType eq::server::FrameData::getChangeType ( ) const [inline, protected, virtual]

Returns:: how the changes are to be handled.

Reimplemented from eq::net::Object.

Definition at line 88 of file server/frameData.h.

References eq::net::Object::INSTANCE.

void eq::server::FrameData::getInstanceData ( net::DataOStream & os ) [protected, virtual]

Serialize the instance information about this managed object.

The default implementation uses the data provided by setInstanceData.

Parameters:

os

The output stream.

Implements eq::net::Object.

Definition at line 34 of file server/frameData.cpp.

void eq::server::FrameData::applyInstanceData ( net::DataIStream & is ) [protected, virtual]

Deserialize the instance data.

This method is called during object mapping to populate slave instances with the master object's data. The default implementation writes the data into the memory declared by setInstanceData.

Parameters:

is

the input stream.

Implements eq::net::Object.

Definition at line 39 of file server/frameData.cpp.

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


Public Member Functions
	FrameData ()
	Constructs a new FrameData.
Data Access
void	setFrameNumber (const uint32_t number)
	Set the number of the frame when this data was last used.
uint32_t	getFrameNumber () const
void	setPixelViewport (const eq::PixelViewport &pvp)
	Set the data's area within the channel.
void	setOffset (const Vector2i &offset)
	Set the position of the data relative to the window.
const Vector2i &	getOffset () const
void	setBuffers (const uint32_t buffers)
	Set the (color, depth) buffers of the source frame.
uint32_t	getBuffers () const
void	setRange (const eq::Range &range)
	Set the source range wrt dest channel.
void	setPixel (const eq::Pixel &pixel)
	Set the source pixel decomposition wrt dest channel.
void	setZoom (const eq::Zoom &zoom)
	Set the output frame zoom factor.
const eq::Zoom &	getZoom () const
eq::Frame::Type	getType () const
	return the frame storage type.
void	setType (const eq::Frame::Type type)
	Set the frame storage type.
Protected Member Functions
virtual ChangeType	getChangeType () const
virtual void	getInstanceData (net::DataOStream &os)
	Serialize the instance information about this managed object.
virtual void	applyInstanceData (net::DataIStream &is)
	Deserialize the instance data.
Friends
class	Frame