#include <hps.h>

Inheritance diagram for HPS::CullingKit:
HPS::Kit HPS::Object

Public Member Functions

 CullingKit ()
 
 CullingKit (CullingKit const &in_kit)
 
 CullingKit (CullingKit &&in_that)
 
bool Empty () const
 
bool Equals (CullingKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (CullingKit const &in_kit) const
 
CullingKitoperator= (CullingKit &&in_that)
 
CullingKitoperator= (CullingKit const &in_kit)
 
bool operator== (CullingKit const &in_kit) const
 
void Set (CullingKit const &in_kit)
 
CullingKitSetBackFace (bool in_state)
 
CullingKitSetDeferralExtent (bool in_state, unsigned int in_pixels)
 
CullingKitSetDeferralExtent (unsigned int in_pixels)
 
CullingKitSetDistance (bool in_state, float in_max_distance)
 
CullingKitSetDistance (float in_max_distance)
 
CullingKitSetExtent (bool in_state, unsigned int in_pixels)
 
CullingKitSetExtent (unsigned int in_pixels)
 
CullingKitSetFrustum (bool in_state)
 
CullingKitSetVector (bool in_state, HPS::Vector const &in_vector, float in_tolerance_degrees)
 
CullingKitSetVector (HPS::Vector const &in_vector, float in_tolerance_degrees)
 
CullingKitSetVector (bool in_state, HPS::Vector const &in_vector=Vector(0.0f, 0.0f, 1.0f))
 
CullingKitSetVector (HPS::Vector const &in_vector)
 
CullingKitSetVectorTolerance (float in_tolerance_degrees)
 
CullingKitSetVolume (bool in_state, HPS::SimpleCuboid const &in_volume=HPS::SimpleCuboid())
 
CullingKitSetVolume (HPS::SimpleCuboid const &in_volume)
 
void Show (CullingKit &out_kit) const
 
bool ShowBackFace (bool &out_state) const
 
bool ShowDeferralExtent (bool &out_state, unsigned int &out_pixels) const
 
bool ShowDistance (bool &out_state, float &out_max_distance) const
 
bool ShowExtent (bool &out_state, unsigned int &out_pixels) const
 
bool ShowFrustum (bool &out_state) const
 
bool ShowVector (bool &out_state, HPS::Vector &out_vector) const
 
bool ShowVectorTolerance (float &out_tolerance_degrees) const
 
bool ShowVolume (bool &out_state, HPS::SimpleCuboid &out_volume) const
 
CullingKitUnsetBackFace ()
 
CullingKitUnsetDeferralExtent ()
 
CullingKitUnsetDistance ()
 
CullingKitUnsetEverything ()
 
CullingKitUnsetExtent ()
 
CullingKitUnsetFrustum ()
 
CullingKitUnsetVector ()
 
CullingKitUnsetVectorTolerance ()
 
CullingKitUnsetVolume ()
 
virtual ~CullingKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static CullingKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::CullingKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The HPS::CullingKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::CullingKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ CullingKit() [1/3]

HPS::CullingKit::CullingKit ( )

Initializes an empty kit.

◆ CullingKit() [2/3]

HPS::CullingKit::CullingKit ( CullingKit const &  in_kit)

The copy constructor creates a new CullingKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

◆ CullingKit() [3/3]

HPS::CullingKit::CullingKit ( CullingKit &&  in_that)

The move constructor creates a CullingKit by transferring the underlying impl of the rvalue reference to this CullingKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a CullingKit to take the impl from.

◆ ~CullingKit()

virtual HPS::CullingKit::~CullingKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::CullingKit::Empty ( ) const
virtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::CullingKit::Equals ( CullingKit const &  in_kit) const

Check if the source CullingKit is equivalent to this object.

Parameters
in_kitThe source CullingKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static CullingKit HPS::CullingKit::GetDefault ( )
static

Creates a CullingKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
A CullingKit with the default settings.

◆ ObjectType()

HPS::Type HPS::CullingKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Kit.

◆ operator!=()

bool HPS::CullingKit::operator!= ( CullingKit const &  in_kit) const

Check if the source CullingKit is not equivalent to this object.

Parameters
in_kitThe source CullingKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

CullingKit& HPS::CullingKit::operator= ( CullingKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this CullingKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a CullingKit to take the impl from.
Returns
A reference to this CullingKit.

◆ operator=() [2/2]

CullingKit& HPS::CullingKit::operator= ( CullingKit const &  in_kit)

Copies the source CullingKit into this object.

Parameters
in_kitThe source CullingKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::CullingKit::operator== ( CullingKit const &  in_kit) const

Check if the source CullingKit is equivalent to this object.

Parameters
in_kitThe source CullingKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::CullingKit::Set ( CullingKit const &  in_kit)

Copies all settings from the source CullingKit into this object.

Parameters
in_kitThe source CullingKit to copy.

◆ SetBackFace()

CullingKit& HPS::CullingKit::SetBackFace ( bool  in_state)

Controls whether faces with normals that point away from the camera should be culled.

Parameters
in_stateWhether faces with normals that point away from the camera should be culled.
Returns
A reference to this object.

◆ SetDeferralExtent() [1/2]

CullingKit& HPS::CullingKit::SetDeferralExtent ( bool  in_state,
unsigned int  in_pixels 
)

Controls whether geometry that falls below a certain size in pixels should be culled with deferral. Deferral culling means the object is given a low-priority draw order, effectively delaying draw time until the end of the frame.

Parameters
in_stateWhether deferral culling should be enabled.
in_pixelsThe number of pixels below which geometry should be culled with deferral.
Returns
A reference to this object.

◆ SetDeferralExtent() [2/2]

CullingKit& HPS::CullingKit::SetDeferralExtent ( unsigned int  in_pixels)

Controls whether geometry that falls below a certain size in pixels should be culled with deferral. Deferral culling means the object is given a low-priority draw order, effectively delaying draw time until the end of the frame. This function implicitly enables deferral extent culling.

Parameters
in_pixelsThe number of pixels below which geometry should be culled with deferral.
Returns
A reference to this object.

◆ SetDistance() [1/2]

CullingKit& HPS::CullingKit::SetDistance ( bool  in_state,
float  in_max_distance 
)

Controls state of distance culling. When using distance culling geometries that lie farther away from the camera than specified in in_max_distance will be culled. in_max_distance is specified in world units.

Parameters
in_stateWhether to use distance culling.
in_max_distanceThe maximum distance from the camera after which geometries will be culled.
Returns
A reference to this object.

◆ SetDistance() [2/2]

CullingKit& HPS::CullingKit::SetDistance ( float  in_max_distance)

Controls state of distance culling. This function implicitly enables distance culling. When using distance culling geometries that lie farther away from the camera than specified in in_max_distance will be culled. in_max_distance is specified in world units.

Parameters
in_max_distanceThe maximum distance from the camera after which geometries will be culled.
Returns
A reference to this object.

◆ SetExtent() [1/2]

CullingKit& HPS::CullingKit::SetExtent ( bool  in_state,
unsigned int  in_pixels 
)

Controls whether geometry that falls below a certain size in pixels should be culled.

Parameters
in_stateWhether extent culling should be enabled.
in_pixelsThe longest dimension of the screen-space projection of the bounding-volume, in pixels.
Returns
A reference to this object.

◆ SetExtent() [2/2]

CullingKit& HPS::CullingKit::SetExtent ( unsigned int  in_pixels)

Controls whether geometry that falls below a certain size in pixels should be culled. This function implicitly enables extent culling.

Parameters
in_pixelsThe longest dimension of the screen-space projection of the bounding-volume, in pixels.
Returns
A reference to this object.

◆ SetFrustum()

CullingKit& HPS::CullingKit::SetFrustum ( bool  in_state)

Controls whether geometry outside the current view frustum should be culled.

Parameters
in_stateWhether geometry outside the current view frustum should be culled.
Returns
A reference to this object.

◆ SetVector() [1/4]

CullingKit& HPS::CullingKit::SetVector ( bool  in_state,
HPS::Vector const &  in_vector,
float  in_tolerance_degrees 
)

Controls the state of vector culling. If the angle between the specified vector and the current view vector is less than the angle defined, then a segment with vector culling enabled will not be drawn.

Parameters
in_stateWhether to use vector culling.
in_vectorThe reference vector to compare the view vector to.
in_tolerance_degreesThe upper limit, in degrees, between the reference vector and the view vector.
Returns
A reference to this object.

◆ SetVector() [2/4]

CullingKit& HPS::CullingKit::SetVector ( HPS::Vector const &  in_vector,
float  in_tolerance_degrees 
)

Controls the state of vector culling. If the angle between the specified vector and the current view vector is less than the angle defined, then a segment with vector culling enabled will not be drawn. This function implicitly enables extent culling.

Parameters
in_vectorThe reference vector to compare the view vector to.
in_tolerance_degreesThe upper limit, in degrees, between the reference vector and the view vector.
Returns
A reference to this object.

◆ SetVector() [3/4]

CullingKit& HPS::CullingKit::SetVector ( bool  in_state,
HPS::Vector const &  in_vector = Vector(0.0f, 0.0f, 1.0f) 
)

Controls the state of vector culling. If the angle between the specified vector and the current view vector is less than the angle defined, then a segment with vector culling enabled will not be drawn. This function does not modify the vector tolerance.

Parameters
in_stateWhether to use vector culling.
in_vectorThe reference vector to compare the view vector to.
Returns
A reference to this object.

◆ SetVector() [4/4]

CullingKit& HPS::CullingKit::SetVector ( HPS::Vector const &  in_vector)

Controls the state of vector culling. If the angle between the specified vector and the current view vector is less than the angle defined, then a segment with vector culling enabled will not be drawn. This function implicitly enables extent culling and does not modify the vector tolerance.

Parameters
in_vectorThe reference vector to compare the view vector to.
Returns
A reference to this object.

◆ SetVectorTolerance()

CullingKit& HPS::CullingKit::SetVectorTolerance ( float  in_tolerance_degrees)

Adjusts the tolerance value used in vector culling. This setting will have no effect is vector culling is not enabled.

Parameters
in_tolerance_degreesThe upper limit, in degrees, between the reference vector and the view vector.
Returns
A reference to this object.

◆ SetVolume() [1/2]

CullingKit& HPS::CullingKit::SetVolume ( bool  in_state,
HPS::SimpleCuboid const &  in_volume = HPS::SimpleCuboid() 
)

Controls state of volume culling. When using volume culling segments whose bounding not inscribed and does not intersect the volume specified by in_volume will be culled. The points of the cuboid passed to this function need to be specified in world units.

Parameters
in_stateWhether to use volume culling.
in_volumeA cuboid used to describe a world-space volume.
Returns
A reference to this object.

◆ SetVolume() [2/2]

CullingKit& HPS::CullingKit::SetVolume ( HPS::SimpleCuboid const &  in_volume)

Controls state of volume culling. When using volume culling segments whose bounding not inscribed and does not intersect the volume specified by in_volume will be culled. The points of the cuboid passed to this function need to be specified in world units.

Parameters
in_volumeA cuboid used to describe a world-space volume.
Returns
A reference to this object.

◆ Show()

void HPS::CullingKit::Show ( CullingKit out_kit) const

Copies all settings from this CullingKit into the given CullingKit.

Parameters
out_kitThe CullingKit to populate with the contents of this object.

◆ ShowBackFace()

bool HPS::CullingKit::ShowBackFace ( bool &  out_state) const

Shows whether faces with normals that point away from the camera should be culled.

Parameters
out_stateWhether faces with normals that point away from the camera should be culled.
Returns
true if the setting is valid, false otherwise.

◆ ShowDeferralExtent()

bool HPS::CullingKit::ShowDeferralExtent ( bool &  out_state,
unsigned int &  out_pixels 
) const

Shows whether geometry that falls below a certain size should be culled with deferral.

Parameters
out_stateWhether deferral culling should be enabled.
out_pixelsThe longest dimension of the screen-space projection of the bounding-volume, in pixels.
Returns
A reference to this object.

◆ ShowDistance()

bool HPS::CullingKit::ShowDistance ( bool &  out_state,
float &  out_max_distance 
) const

Shows the state of distance culling. When distance culling is active, geometries that lie farther away from the camera than out_max_distance will be culled.

Parameters
out_stateWhether distance culling is being used.
out_max_distanceThe maximum distance away from the camera before geometries are culled.
Returns
true if the setting is valid, false otherwise.

◆ ShowExtent()

bool HPS::CullingKit::ShowExtent ( bool &  out_state,
unsigned int &  out_pixels 
) const

Shows whether geometry that falls below a certain size should be culled.

Parameters
out_stateWhether extent culling should be enabled.
out_pixelsThe longest dimension of the screen-space projection of the bounding-volume, in pixels.
Returns
true if the setting is valid, false otherwise.

◆ ShowFrustum()

bool HPS::CullingKit::ShowFrustum ( bool &  out_state) const

Shows whether geometry outside the current view frustum should be culled.

Parameters
out_stateWhether geometry outside the current view frustum should be culled.
Returns
true if the setting is valid, false otherwise.

◆ ShowVector()

bool HPS::CullingKit::ShowVector ( bool &  out_state,
HPS::Vector out_vector 
) const

Shows the state of vector culling. If the angle between the specified vector and the current view vector is less than the angle defined, then a segment with vector culling enabled will not be drawn.

Parameters
out_stateWhether to use vector culling.
out_vectorThe reference vector to compare the view vector to.
Returns
true if the setting is valid, false otherwise.

◆ ShowVectorTolerance()

bool HPS::CullingKit::ShowVectorTolerance ( float &  out_tolerance_degrees) const

Shows the tolerance value used in vector culling. This setting will have no effect is vector culling is not enabled.

Parameters
out_tolerance_degreesThe upper limit, in degrees, between the reference vector and the view vector.
Returns
true if the setting is valid, false otherwise.

◆ ShowVolume()

bool HPS::CullingKit::ShowVolume ( bool &  out_state,
HPS::SimpleCuboid out_volume 
) const

Shows the state of volume culling. When volume culling is active, segments whose bounding is not inscribed or intersecting out_volume will be culled.

Parameters
out_stateWhether volume culling is being used.
out_volumeA cuboid defining a world-space volume.
Returns
true if the setting is valid, false otherwise.

◆ UnsetBackFace()

CullingKit& HPS::CullingKit::UnsetBackFace ( )

Removes the back face culling setting.

Returns
A reference to this object.

◆ UnsetDeferralExtent()

CullingKit& HPS::CullingKit::UnsetDeferralExtent ( )

Removes the extent culling setting.

Returns
A reference to this object.

◆ UnsetDistance()

CullingKit& HPS::CullingKit::UnsetDistance ( )

Removes the distance culling setting.

Returns
A reference to this object.

◆ UnsetEverything()

CullingKit& HPS::CullingKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetExtent()

CullingKit& HPS::CullingKit::UnsetExtent ( )

Removes the extent culling setting.

Returns
A reference to this object.

◆ UnsetFrustum()

CullingKit& HPS::CullingKit::UnsetFrustum ( )

Removes the frustum culling setting.

Returns
A reference to this object.

◆ UnsetVector()

CullingKit& HPS::CullingKit::UnsetVector ( )

Removes the vector culling setting while leaving the vector tolerance unmodified.

Returns
A reference to this object.

◆ UnsetVectorTolerance()

CullingKit& HPS::CullingKit::UnsetVectorTolerance ( )

Removes the vector culling tolerance setting only.

Returns
A reference to this object.

◆ UnsetVolume()

CullingKit& HPS::CullingKit::UnsetVolume ( )

Removes the volume culling setting.

Returns
A reference to this object.

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