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

nvsg::HighlightEdges Class Reference

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

#include <HighlightEdges.h>

Inheritance diagram for nvsg::HighlightEdges:

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

Collaboration graph
[legend]
List of all members.

Public Methods

virtual NVSG_API const HighlightEdges * clone (void) const
 Create a HighlightEdges by cloning this. More...

virtual NVSG_API bool isBoundingSphereValid (void) const
 This object does not hold any geometry, so it's bounding sphere is not valid. More...

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

NVSG_API float getLineWidth (void) const
 return the line width used for drawing the box. More...

NVSG_API const nvmath::Vec3fgetColor (void) const
 return the line width used for drawing the box. More...


Static Public Methods

NVSG_API const HighlightEdges * create (float width=2.0f, nvmath::Vec3f color=nvmath::Vec3f(1.0f, 0.0f, 0.0f))
 Create a HighlightEdges. More...

NVSG_API const HighlightEdges * createFromBase (const HighlightObject &rhs, float width=2.0f, nvmath::Vec3f color=nvmath::Vec3f(1.0f, 0.0f, 0.0f))
 Create a HighlightEdges by copying from a HighlightObject. More...


Protected Methods

NVSG_API HighlightEdges (float width, nvmath::Vec3f color)
 Constructor with line width and color. More...

NVSG_API HighlightEdges (const HighlightObject &rhs, float width, nvmath::Vec3f color)
 Partial Constructor. More...

NVSG_API HighlightEdges (const HighlightEdges &rhs)
 Copy Constructor. More...


Protected Attributes

float m_lineWidth
 line width used for drawing the bounding box. More...

nvmath::Vec3f m_color
 color used for drawing. More...


Detailed Description

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


Constructor & Destructor Documentation

NVSG_API nvsg::HighlightEdges::HighlightEdges float    width,
nvmath::Vec3f    color
[protected]
 

Constructor with line width and color.

NVSG_API nvsg::HighlightEdges::HighlightEdges const HighlightObject   rhs,
float    width,
nvmath::Vec3f    color
[protected]
 

Partial Constructor.

NVSG_API nvsg::HighlightEdges::HighlightEdges const HighlightEdges &    rhs [protected]
 

Copy Constructor.


Member Function Documentation

NVSG_API const HighlightEdges* nvsg::HighlightEdges::create float    width = 2.0f,
nvmath::Vec3f    color = nvmath::Vec3f(1.0f, 0.0f, 0.0f)
[static]
 

Create a HighlightEdges.

Returns:
a constant pointer to a HighlightEdges.
Parameters:
width  default line width
color  default line color

NVSG_API const HighlightEdges* nvsg::HighlightEdges::createFromBase const HighlightObject   rhs,
float    width = 2.0f,
nvmath::Vec3f    color = nvmath::Vec3f(1.0f, 0.0f, 0.0f)
[static]
 

Create a HighlightEdges by copying from a HighlightObject.

Returns:
a constant pointer to a HighlightBox.
Parameters:
rhs  HighlightObject to copy from
width  default line width
color  default line color

virtual NVSG_API const HighlightEdges* nvsg::HighlightEdges::clone void    const [virtual]
 

Create a HighlightEdges by cloning this.

Returns:
a constant pointer to a HighlightEdges.

bool nvsg::HighlightEdges::isBoundingSphereValid void    const [inline, virtual]
 

This object does not hold any geometry, so it's bounding sphere is not valid.

Returns:
false

Implements nvsg::HighlightObject.

const nvmath::Sphere3f & nvsg::HighlightEdges::getBoundingSphere void    const [inline, virtual]
 

Get the bounding sphere of this HighlightObject.

A HighlightEdges object does not have a bounding sphere, therefor this function shouldn't be used.

Implements nvsg::HighlightObject.

float nvsg::HighlightEdges::getLineWidth void    const [inline]
 

return the line width used for drawing the box.

const nvmath::Vec3f & nvsg::HighlightEdges::getColor void    const [inline]
 

return the line width used for drawing the box.


Member Data Documentation

float nvsg::HighlightEdges::m_lineWidth [protected]
 

line width used for drawing the bounding box.

nvmath::Vec3f nvsg::HighlightEdges::m_color [protected]
 

color used for drawing.


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