HPS::OOC::Area Class Reference

The Area class is represents a quadrilateral area for highlighting. More...

#include <sprk_ooc.h>

Collaboration diagram for HPS::OOC::Area:

Public Member Functions
	Area ()
	Area (HPS::Rectangle const &in_rect, HPS::MatrixKit const &in_world_to_window, const char *in_name)
bool	Intersects (HPS::SimpleCuboid const &world_space_bounding) const
	Determines if a cuboid intersects this Area. More...
bool	Intersects (HPS::Point const &world_space_point) const
	Determines if a point intersects this Area. More...
HPS::Point const &	GetWindowMin () const
HPS::Point const &	GetWindowMax () const
HPS::MatrixKit const &	GetWorldToWindow () const
	Returns the MatrixKit associated with this Area. More...
HPS::UTF8 const &	GetName () const
	Returns the name associated with this Area. More...

Protected Attributes
HPS::Point	window_min
HPS::Point	window_max
HPS::MatrixKit	world_to_window
HPS::UTF8	name

Detailed Description

The Area class is represents a quadrilateral area for highlighting.

Constructor & Destructor Documentation

Area() [1/2]

HPS::OOC::Area::Area ( )

inline

Area() [2/2]

HPS::OOC::Area::Area ( HPS::Rectangle const &  in_rect, HPS::MatrixKit const &  in_world_to_window, const char *  in_name  )

inline

Member Function Documentation

GetName()

HPS::UTF8 const& HPS::OOC::Area::GetName ( ) const

inline

Returns the name associated with this Area.

GetWindowMax()

HPS::Point const& HPS::OOC::Area::GetWindowMax ( ) const

inline

GetWindowMin()

HPS::Point const& HPS::OOC::Area::GetWindowMin ( ) const

inline

GetWorldToWindow()

HPS::MatrixKit const& HPS::OOC::Area::GetWorldToWindow ( ) const

inline

Returns the MatrixKit associated with this Area.

Intersects() [1/2]

bool HPS::OOC::Area::Intersects ( HPS::SimpleCuboid const &  world_space_bounding ) const

inline

Determines if a cuboid intersects this Area.

Parameters

world_space_bounding

The cuboid to test

Returns

true if the cuboid interects this area, false otherwise.

Here is the call graph for this function:

Intersects() [2/2]

bool HPS::OOC::Area::Intersects ( HPS::Point const &  world_space_point ) const

inline

Determines if a point intersects this Area.

Parameters

world_space_point

The point to test

Returns

true if the point intersects this area, false otherwise.

Member Data Documentation

name

HPS::UTF8 HPS::OOC::Area::name

protected

window_max

HPS::Point HPS::OOC::Area::window_max

protected

window_min

HPS::Point HPS::OOC::Area::window_min

protected

world_to_window

HPS::MatrixKit HPS::OOC::Area::world_to_window

protected

---

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

• sprk_ooc.h