Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

nvsg::HighlightObject Class Reference

Base class for Highlighting objects that can be attached to Geosets. More...

#include <HighlightObject.h>

Inheritance diagram for nvsg::HighlightObject:

Inheritance graph
[legend]
Collaboration diagram for nvsg::HighlightObject:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual NVSG_API bool isBoundingSphereValid (void) const=0
 Ask if the bounding sphere of this HighlightObject is valid. More...

virtual NVSG_API const nvmath::Sphere3fgetBoundingSphere (void) const=0
 Get the bounding sphere of this HighlightObject. More...

virtual NVSG_API bool isValid (void) const
 Tells us whether the highlight object needs to be recalculated. More...

virtual NVSG_API void invalidate (void)
 Invalidate highlight geometry, so that it will be recalculated. More...


Protected Methods

NVSG_API HighlightObject (void)
 Constructor. More...


Protected Attributes

bool m_invalid
 set if the highlight needs to be recalculated. More...


Detailed Description

Base class for Highlighting objects that can be attached to Geosets.


Constructor & Destructor Documentation

nvsg::HighlightObject::HighlightObject void    [inline, protected]
 

Constructor.


Member Function Documentation

virtual NVSG_API bool nvsg::HighlightObject::isBoundingSphereValid void    const [pure virtual]
 

Ask if the bounding sphere of this HighlightObject is valid.

If the bounding sphere isn't valid, it is tried to validate it.

Returns:
The valid state of the bounding sphere.

Implemented in nvsg::HighlightBox, and nvsg::HighlightEdges.

virtual NVSG_API const nvmath::Sphere3f& nvsg::HighlightObject::getBoundingSphere void    const [pure virtual]
 

Get the bounding sphere of this HighlightObject.

The bounding sphere of a Node is a sphere that completely contains the HighlightObject.

Note:
It is assumed that the bounding sphere of this HighlightObject is valid.
Returns:
A constant reference to the bounding sphere.

Implemented in nvsg::HighlightBox, and nvsg::HighlightEdges.

bool nvsg::HighlightObject::isValid void    const [inline, virtual]
 

Tells us whether the highlight object needs to be recalculated.

Calculation is required before first rendering, and every time the associated geometry is changed.

void nvsg::HighlightObject::invalidate void    [inline, virtual]
 

Invalidate highlight geometry, so that it will be recalculated.


Member Data Documentation

bool nvsg::HighlightObject::m_invalid [protected]
 

set if the highlight needs to be recalculated.


The documentation for this class was generated from the following file:
Generated on Tue Mar 1 13:20:27 2005 for NVSGSDK by NVIDIA