HPS::OOC::AreaHighlightTracker Class Reference

Override this class to customize Area Highlighting. More...

#include <sprk_ooc.h>

Collaboration diagram for HPS::OOC::AreaHighlightTracker:

Public Member Functions
	AreaHighlightTracker (HPS::Canvas const &in_canvas, HPS::SegmentKey const &in_area_cameras)
virtual	~AreaHighlightTracker ()
virtual void	Process (HPS::KeyArray const &shell_keys)
void	Clear ()
	Removes all Areas from this object. More...
bool	Empty () const
	Returns true if this object is not tracking any Areas. More...
void	AddArea (HPS::Rectangle const &in_rect, HPS::MatrixKit const &in_world_to_window, bool in_clear)
	Adds an Area to track. More...
void	AddPoint (HPS::WorldPoint const &in_point, bool in_clear)
	Adds a world space point to track. More...
bool	Intersects (HPS::SimpleCuboid const &world_space_bounding) const
	Determines if a cuboid intersects any of the tracked Areas. More...
bool	Intersects (HPS::Point const &world_space_point) const
	Determines if a point intersects any of the tracked Areas. More...
HPS::OOC::AreaArray const &	GetAreas () const
	Returns an array of all of the tracked Areas. More...
HPS::Canvas const &	GetCanvas () const
	Returns the Canvas associated with this object. More...
HPS::WindowKey const &	GetWindowKey () const
	Returns the WindowKey associated with this object. More...
HPS::SegmentKey const &	GetAreaCameraSegment () const
	Returns the Camera SegmentKey associated with this object. More...
bool	GetInspecting () const

Private Attributes
void *	opaque

Friends
class	HBaseView
class	PointCloud

Detailed Description

Override this class to customize Area Highlighting.

Constructor & Destructor Documentation

AreaHighlightTracker()

HPS::OOC::AreaHighlightTracker::AreaHighlightTracker	(	HPS::Canvas const &	in_canvas,
		HPS::SegmentKey const &	in_area_cameras
	)

~AreaHighlightTracker()

virtual HPS::OOC::AreaHighlightTracker::~AreaHighlightTracker ( )

virtual

Member Function Documentation

AddArea()

void HPS::OOC::AreaHighlightTracker::AddArea	(	HPS::Rectangle const &	in_rect,
		HPS::MatrixKit const &	in_world_to_window,
		bool	in_clear
	)

Adds an Area to track.

Parameters

in_rect	The quadrilateral area to being tracking.
in_world_to_window	The MatrixKit associated with this Area.
in_clear	Indicates if all preexisting Areas should be removed before adding this new Area.

AddPoint()

void HPS::OOC::AreaHighlightTracker::AddPoint	(	HPS::WorldPoint const &	in_point,
		bool	in_clear
	)

Adds a world space point to track.

Parameters

in_point	The world space point being tracking.
in_clear	Indicates if all preexisting point should be removed before adding this new point.

Clear()

void HPS::OOC::AreaHighlightTracker::Clear

(

)

Removes all Areas from this object.

Empty()

bool HPS::OOC::AreaHighlightTracker::Empty

(

)

const

Returns true if this object is not tracking any Areas.

GetAreaCameraSegment()

HPS::SegmentKey const& HPS::OOC::AreaHighlightTracker::GetAreaCameraSegment

(

)

const

Returns the Camera SegmentKey associated with this object.

GetAreas()

HPS::OOC::AreaArray const& HPS::OOC::AreaHighlightTracker::GetAreas

(

)

const

Returns an array of all of the tracked Areas.

GetCanvas()

HPS::Canvas const& HPS::OOC::AreaHighlightTracker::GetCanvas

(

)

const

Returns the Canvas associated with this object.

GetInspecting()

bool HPS::OOC::AreaHighlightTracker::GetInspecting

(

)

const

GetWindowKey()

HPS::WindowKey const& HPS::OOC::AreaHighlightTracker::GetWindowKey

(

)

const

Returns the WindowKey associated with this object.

Intersects() [1/2]

bool HPS::OOC::AreaHighlightTracker::Intersects

(

HPS::SimpleCuboid const &

world_space_bounding

)

const

Determines if a cuboid intersects any of the tracked Areas.

Parameters

world_space_bounding

The cuboid to test

Returns

true if the cuboid intersects one of the tracked Areas, false otherwise.

Intersects() [2/2]

bool HPS::OOC::AreaHighlightTracker::Intersects

(

HPS::Point const &

world_space_point

)

const

Determines if a point intersects any of the tracked Areas.

Parameters

world_space_point

The point to test

Returns

true if the point intersects one of the tracked Areas, false otherwise.

Process()

virtual void HPS::OOC::AreaHighlightTracker::Process ( HPS::KeyArray const &  shell_keys )

inlinevirtual

Friends And Related Function Documentation

HBaseView

friend class HBaseView

friend

PointCloud

friend class PointCloud

friend

Member Data Documentation

opaque

void* HPS::OOC::AreaHighlightTracker::opaque

private

---

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

• sprk_ooc.h