ROI Class Reference

[AI] Abstract base class for Real-time Object Instances (ROI) in the world. More...

#include <roi.h>

Inheritance diagram for ROI:

Collaboration diagram for ROI:

Public Member Functions
	ROI ()
	[AI] Constructs an empty ROI, initially visible with no LOD or compound object assigned. More...
virtual	~ROI ()
	[AI] Destroys the ROI and asserts that 'comp' and 'lods' are managed/deleted by derived types. More...
virtual float	IntrinsicImportance () const =0
	[AI] Returns the intrinsic importance (used for LOD selection, culling etc). More...
virtual const float *	GetWorldVelocity () const =0
	[AI] Returns the object's world-space velocity as a pointer to float values. More...
virtual const BoundingBox &	GetWorldBoundingBox () const =0
	[AI] Returns the world-space bounding box of the object. More...
virtual const BoundingSphere &	GetWorldBoundingSphere () const =0
	[AI] Returns the world-space bounding sphere of the object. More...
const LODListBase *	GetLODs () const
	[AI] Returns the LOD list associated with this ROI, or NULL if not set. More...
const LODObject *	GetLOD (int i) const
	[AI] Returns the LODObject at the specified index. More...
int	GetLODCount () const
	[AI] Returns the number of available LODs for this ROI. More...
const CompoundObject *	GetComp () const
	[AI] Returns the pointer to the compound object structure, or NULL if not present. More...
unsigned char	GetVisibility ()
	[AI] Returns the visibility flag; true if visible, false if hidden. More...
void	SetVisibility (unsigned char p_visible)
	[AI] Sets the visibility flag to the provided value. More...

Protected Attributes
CompoundObject *	comp
	[AI] List of sub-ROIs composing this ROI (compound object), or NULL. [AI] More...
LODListBase *	lods
	[AI] Pointer to list of LODObject instances, or NULL if not set. [AI] More...
unsigned char	m_visible
	[AI] Visibility flag: nonzero = visible. [AI] More...

Detailed Description

[AI] Abstract base class for Real-time Object Instances (ROI) in the world.

[AI] Handles the basic properties and methods for game engine objects placed in the 3D world, including LODs, compound structure, and visibility. Subclasses provide transformations and geometry.

Definition at line 162 of file roi.h.

Constructor & Destructor Documentation

ROI()

ROI::ROI ( )

inline

[AI] Constructs an empty ROI, initially visible with no LOD or compound object assigned.

[AI]

Definition at line 167 of file roi.h.

~ROI()

virtual ROI::~ROI ( )

inlinevirtual

[AI] Destroys the ROI and asserts that 'comp' and 'lods' are managed/deleted by derived types.

[AI]

Definition at line 176 of file roi.h.

Member Function Documentation

GetComp()

const CompoundObject * ROI::GetComp ( ) const

inline

[AI] Returns the pointer to the compound object structure, or NULL if not present.

[AI]

Definition at line 222 of file roi.h.

GetLOD()

const LODObject * ROI::GetLOD ( int  i ) const

inline

[AI] Returns the LODObject at the specified index.

Asserts that LODs are present. [AI]

Parameters

i	Index of the LOD to return. [AI]

Definition at line 208 of file roi.h.

GetLODCount()

int ROI::GetLODCount ( ) const

inline

[AI] Returns the number of available LODs for this ROI.

[AI]

Definition at line 216 of file roi.h.

GetLODs()

const LODListBase * ROI::GetLODs ( ) const

inline

[AI] Returns the LOD list associated with this ROI, or NULL if not set.

[AI]

Definition at line 203 of file roi.h.

GetVisibility()

unsigned char ROI::GetVisibility ( )

inline

[AI] Returns the visibility flag; true if visible, false if hidden.

[AI]

Definition at line 228 of file roi.h.

GetWorldBoundingBox()

virtual const BoundingBox & ROI::GetWorldBoundingBox ( ) const

pure virtual

[AI] Returns the world-space bounding box of the object.

Pure virtual.

Implemented in OrientableROI.

GetWorldBoundingSphere()

virtual const BoundingSphere & ROI::GetWorldBoundingSphere ( ) const

pure virtual

[AI] Returns the world-space bounding sphere of the object.

Pure virtual.

Implemented in OrientableROI.

GetWorldVelocity()

virtual const float * ROI::GetWorldVelocity ( ) const

pure virtual

[AI] Returns the object's world-space velocity as a pointer to float values.

Pure virtual.

Returns

Pointer to float array (typically 3 floats for velocity) [AI]

Implemented in OrientableROI.

IntrinsicImportance()

virtual float ROI::IntrinsicImportance ( ) const

pure virtual

[AI] Returns the intrinsic importance (used for LOD selection, culling etc).

Pure virtual.

Implemented in LegoROI, and ViewROI.

SetVisibility()

void ROI::SetVisibility ( unsigned char  p_visible )

inline

[AI] Sets the visibility flag to the provided value.

[AI]

Parameters

p_visible

Set true to make visible, false to hide. [AI]

Definition at line 235 of file roi.h.

Member Data Documentation

comp

CompoundObject* ROI::comp

protected

[AI] List of sub-ROIs composing this ROI (compound object), or NULL. [AI]

Definition at line 241 of file roi.h.

lods

LODListBase* ROI::lods

protected

[AI] Pointer to list of LODObject instances, or NULL if not set. [AI]

Definition at line 242 of file roi.h.

m_visible

unsigned char ROI::m_visible

protected

[AI] Visibility flag: nonzero = visible. [AI]

Definition at line 243 of file roi.h.

---

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

• roi.h