VizKit::VisualObject Class Reference

Basic abstract object data type of core objects. More...

#include <VisualObject.h>

Inheritance diagram for VizKit::VisualObject:

List of all members.

Public Member Functions
	VisualObject ()
	The constructor.
	VisualObject (const VisualItemIdentifier &anIdentifier)
	Another constructor.
virtual	~VisualObject ()
	The destructor.
	VisualObject (const VisualObject &other)
	Copy constructor.
VisualObject &	operator= (const VisualObject &other)
	Assignment operator.
bool	operator< (const VisualObject &other) const
	Less than operator.
bool	operator> (const VisualObject &other) const
	Greater than operator.
bool	operator== (const VisualObject &other) const
	Equality operator.
bool	operator!= (const VisualObject &other) const
	Inequality operator.
virtual VisualObject *	clone (void) const =0
	Copies the current VisualObject and returns a pointer to a new VisualObject.
const VisualItemIdentifier	getIdentifier (void) const
	Returns the identifier of the object item.
bool	addData (void *dataPtr, size_t dataSize)
	Adds data to the object.
void	freeData (void)
	Deallocates the data if there has been data allocated.
size_t	getDataSizeUsed (void)
	Returns the number of bytes currently used by the internal data buffer.
size_t	getDataSizeDeclared (void)
	Returns the declared size in bytes of the object.
void	setDataSizeDeclared (const size_t &aDataSizeDeclared)
	Sets the declared size in bytes of the object.
bool	dataSizeDeclaredHasBeenSet (void)
	Returns whether the declared data size has been set yet.
VisualObjectData *	getVisualObjectData (void)
	Returns a shared pointer to the visualObjectData.
virtual void	dataLoadDidEnd (const VisualItemIdentifier &identifier)
	Notification that the loading of data ended.
Protected Member Functions
bool	hasData (void)
	Answers the question whether the internal data buffer has data available.
char *	getData (void)
	Returns a pointer to the internal data buffer.
size_t	getDataSize (void)
	Returns the number of bytes of the internal data buffer.
Private Member Functions
void	copyObject (const VisualObject &other)
	Copy method for assignment operator and copy constructor.
Private Attributes
VisualObjectData *	visualObjectData
	Pointer to object data.

---

Detailed Description

Basic abstract object data type of core objects.

---

Constructor & Destructor Documentation

VisualObject::VisualObject

(

)

The constructor.

VisualObject::VisualObject

(

const VisualItemIdentifier &

anIdentifier

)

Another constructor.

Parameters:

anIdentifier

Identifier of the object.

VisualObject::~VisualObject

(

)

[virtual]

The destructor.

VisualObject::VisualObject

(

const VisualObject &

other

)

Copy constructor.

Parameters:

other

Reference to another VisualObject.

---

Member Function Documentation

bool VisualObject::addData	(	void *	dataPtr,
		size_t	dataSize
	)

Adds data to the object.

Parameters:

dataPtr	Pointer to data.
dataSize	The number of bytes of the dataPtr.

Returns:

True on success, false on failure.

Remarks:

The data is copied.

virtual VisualObject* VizKit::VisualObject::clone

(

void

)

const [pure virtual]

Copies the current VisualObject and returns a pointer to a new VisualObject.

Implemented in VizKit::VisualString, VizKit::VisualFile, VizKit::VisualTextAutoScrollView, VizKit::VisualAsset, VizKit::VisualAnimation, VizKit::VisualImage, VizKit::VisualNotification, VizKit::VisualAnimationCluster, VizKit::VisualAnimationSequence, VizKit::VisualStyledString, VizKit::VisualStringStyle, and VizKit::VisualAnimationComponent.

void VisualObject::copyObject

(

const VisualObject &

other

)

[private]

Copy method for assignment operator and copy constructor.

Parameters:

other

Another VisualObject.

void VisualObject::dataLoadDidEnd

(

const VisualItemIdentifier &

identifier

)

[virtual]

Notification that the loading of data ended.

Parameters:

identifier

The identifier of the data load request.

Remarks:

Hook method that can be overridden by subclasses of VisualObject for post-processing of received data.

Reimplemented in VizKit::VisualString, and VizKit::VisualImage.

bool VisualObject::dataSizeDeclaredHasBeenSet

(

void

)

Returns whether the declared data size has been set yet.

Returns:

Boolean flag answers the question whether the declared data size has been set yet.

void VisualObject::freeData

(

void

)

Deallocates the data if there has been data allocated.

char * VisualObject::getData

(

void

)

[protected]

Returns a pointer to the internal data buffer.

Returns:

A pointer to the internal data buffer.

size_t VisualObject::getDataSize

(

void

)

[protected]

Returns the number of bytes of the internal data buffer.

Returns:

The number of bytes of the internal data buffer.

size_t VisualObject::getDataSizeDeclared

(

void

)

Returns the declared size in bytes of the object.

Returns:

The declared size in bytes of the object.

Remarks:

The size can be declared by a remote header file before the actual data has been fetched.

size_t VisualObject::getDataSizeUsed

(

void

)

Returns the number of bytes currently used by the internal data buffer.

Returns:

The number of bytes currently used by the internal data buffer.

const VisualItemIdentifier VisualObject::getIdentifier

(

void

)

const

Returns the identifier of the object item.

Returns:

The identifier of the object item.

VisualObjectData * VisualObject::getVisualObjectData

(

void

)

Returns a shared pointer to the visualObjectData.

Returns:

A shared pointer to the visualObjectData.

Remarks:

The caller has to call release() on the visualObjectData pointer after use.

bool VisualObject::hasData

(

void

)

[protected]

Answers the question whether the internal data buffer has data available.

Returns:

True if the internal data buffer has data available, false otherwise.

bool VisualObject::operator!=

(

const VisualObject &

other

)

const

Inequality operator.

Parameters:

other

Another VisualObject.

bool VisualObject::operator<

(

const VisualObject &

other

)

const

Less than operator.

Parameters:

other

Another VisualObject.

Remarks:

The less than operator is used by std::map for find() and sorting (if VisualObject is used as key_type).

VisualObject & VisualObject::operator=

(

const VisualObject &

other

)

Assignment operator.

Parameters:

other

Reference to another VisualObject.

bool VisualObject::operator==

(

const VisualObject &

other

)

const

Equality operator.

Parameters:

other

Another VisualObject.

bool VisualObject::operator>

(

const VisualObject &

other

)

const

Greater than operator.

Parameters:

other

Another VisualObject.

Remarks:

The less than operator is used by std::map for find() and sorting (if VisualObject is used as key_type).

void VisualObject::setDataSizeDeclared

(

const size_t &

aDataSizeDeclared

)

Sets the declared size in bytes of the object.

Parameters:

aDataSizeDeclared

The number of bytes declared.

Remarks:

The size can be declared by a remote header file before the actual data has been fetched.

---

Member Data Documentation

VisualObjectData* VizKit::VisualObject::visualObjectData [private]

Pointer to object data.

---

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

• vizkit/source/VisualObject.h
• vizkit/source/VisualObject.cpp