HPS::OOC::AreaHighlightTracker Class Reference

#include <sprk_ooc.h>

Public Member Functions

void AddArea (HPS::Rectangle const &in_rect, HPS::MatrixKit const &in_world_to_window, bool in_clear)
 
void AddPoint (HPS::WorldPoint const &in_point, bool in_clear)
 
AreaHighlightTracker (HPS::Canvas const &in_canvas, HPS::SegmentKey const &in_area_cameras)
 
void Clear ()
 
bool Empty () const
 
HPS::SegmentKey const & GetAreaCameraSegment () const
 
HPS::OOC::AreaArray const & GetAreas () const
 
HPS::Canvas const & GetCanvas () const
 
bool GetInspecting () const
 
HPS::WindowKey const & GetWindowKey () const
 
bool Intersects (HPS::SimpleCuboid const &world_space_bounding) const
 
bool Intersects (HPS::Point const &world_space_point) const
 
virtual void Process (HPS::KeyArray const &shell_keys)
 

Friends

class HBaseView
 
class PointCloud
 

Detailed Description

Override this class to customize Area Highlighting.

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_rectThe quadrilateral area to being tracking.
in_world_to_windowThe MatrixKit associated with this Area.
in_clearIndicates 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_pointThe world space point being tracking.
in_clearIndicates 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.

◆ 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_boundingThe 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_pointThe point to test
Returns
true if the point intersects one of the tracked Areas, false otherwise.

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