#include <hps.h>
|
| 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 |
|
CullingKit & | operator= (CullingKit &&in_that) |
|
CullingKit & | operator= (CullingKit const &in_kit) |
|
bool | operator== (CullingKit const &in_kit) const |
|
void | Set (CullingKit const &in_kit) |
|
CullingKit & | SetBackFace (bool in_state) |
|
CullingKit & | SetDeferralExtent (bool in_state, unsigned int in_pixels) |
|
CullingKit & | SetDeferralExtent (unsigned int in_pixels) |
|
CullingKit & | SetExtent (bool in_state, unsigned int in_pixels) |
|
CullingKit & | SetExtent (unsigned int in_pixels) |
|
CullingKit & | SetFrustum (bool in_state) |
|
CullingKit & | SetVector (bool in_state, HPS::Vector const &in_vector, float in_tolerance_degrees) |
|
CullingKit & | SetVector (HPS::Vector const &in_vector, float in_tolerance_degrees) |
|
CullingKit & | SetVector (bool in_state, HPS::Vector const &in_vector=Vector(0.0f, 0.0f, 1.0f)) |
|
CullingKit & | SetVector (HPS::Vector const &in_vector) |
|
CullingKit & | SetVectorTolerance (float in_tolerance_degrees) |
|
void | Show (CullingKit &out_kit) const |
|
bool | ShowBackFace (bool &out_state) const |
|
bool | ShowDeferralExtent (bool &out_state, unsigned int &out_pixels) 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 |
|
CullingKit & | UnsetBackFace () |
|
CullingKit & | UnsetDeferralExtent () |
|
CullingKit & | UnsetEverything () |
|
CullingKit & | UnsetExtent () |
|
CullingKit & | UnsetFrustum () |
|
CullingKit & | UnsetVector () |
|
CullingKit & | UnsetVectorTolerance () |
|
virtual | ~CullingKit () |
|
virtual HPS::Type | Type () const |
|
intptr_t | GetClassID () const |
|
intptr_t | GetInstanceID () const |
|
bool | HasType (HPS::Type in_mask) const |
|
| Object (Object const &that) |
|
| Object (Object &&in_that) |
|
Object & | operator= (Object const &other_object) |
|
Object & | operator= (Object &&in_that) |
|
virtual void | Reset () |
|
|
static const HPS::Type | staticType = HPS::Type::CullingKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
HPS::CullingKit::CullingKit |
( |
| ) |
|
Initializes an empty kit.
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_kit | The source object to copy. |
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_that | An rvalue reference to a CullingKit to take the impl from. |
virtual HPS::CullingKit::~CullingKit |
( |
| ) |
|
|
virtual |
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.
bool HPS::CullingKit::Equals |
( |
CullingKit const & |
in_kit | ) |
const |
Check if the source CullingKit is equivalent to this object.
- Parameters
-
in_kit | The source CullingKit to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
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.
bool HPS::CullingKit::operator!= |
( |
CullingKit const & |
in_kit | ) |
const |
Check if the source CullingKit is not equivalent to this object.
- Parameters
-
in_kit | The source CullingKit to compare to this object. |
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this CullingKit thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a CullingKit to take the impl from. |
- Returns
- A reference to this CullingKit.
Copies the source CullingKit into this object.
- Parameters
-
- Returns
- A reference to this object.
bool HPS::CullingKit::operator== |
( |
CullingKit const & |
in_kit | ) |
const |
Check if the source CullingKit is equivalent to this object.
- Parameters
-
in_kit | The source CullingKit to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::CullingKit::Set |
( |
CullingKit const & |
in_kit | ) |
|
Copies all settings from the source CullingKit into this object.
- Parameters
-
CullingKit& HPS::CullingKit::SetBackFace |
( |
bool |
in_state | ) |
|
Controls whether faces with normals that point away from the camera should be culled.
- Parameters
-
in_state | Whether faces with normals that point away from the camera should be culled. |
- Returns
- A reference to this object.
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_state | Whether deferral culling should be enabled. |
in_pixels | The number of pixels below which geometry should be culled with deferral. |
- Returns
- A reference to this object.
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_pixels | The number of pixels below which geometry should be culled with deferral. |
- Returns
- A reference to this object.
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_state | Whether extent culling should be enabled. |
in_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
- Returns
- A reference to this object.
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_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
- Returns
- A reference to this object.
CullingKit& HPS::CullingKit::SetFrustum |
( |
bool |
in_state | ) |
|
Controls whether geometry outside the current view frustum should be culled.
- Parameters
-
in_state | Whether geometry outside the current view frustum should be culled. |
- Returns
- A reference to this object.
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_state | Whether to use vector culling. |
in_vector | The reference vector to compare the view vector to. |
in_tolerance_degrees | The upper limit, in degrees, between the reference vector and the view vector. |
- Returns
- A reference to this object.
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_vector | The reference vector to compare the view vector to. |
in_tolerance_degrees | The upper limit, in degrees, between the reference vector and the view vector. |
- Returns
- A reference to this object.
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_state | Whether to use vector culling. |
in_vector | The reference vector to compare the view vector to. |
- Returns
- A reference to this object.
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_vector | The reference vector to compare the view vector to. |
- Returns
- A reference to this object.
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_degrees | The upper limit, in degrees, between the reference vector and the view vector. |
- Returns
- A reference to this object.
void HPS::CullingKit::Show |
( |
CullingKit & |
out_kit | ) |
const |
bool HPS::CullingKit::ShowBackFace |
( |
bool & |
out_state | ) |
const |
Shows whether faces with normals that point away from the camera should be culled.
- Parameters
-
out_state | Whether faces with normals that point away from the camera should be culled. |
- Returns
- true if the setting is valid, false otherwise.
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_state | Whether deferral culling should be enabled. |
out_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
- Returns
- A reference to this object.
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_state | Whether extent culling should be enabled. |
out_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
- Returns
- true if the setting is valid, false otherwise.
bool HPS::CullingKit::ShowFrustum |
( |
bool & |
out_state | ) |
const |
Shows whether geometry outside the current view frustum should be culled.
- Parameters
-
out_state | Whether geometry outside the current view frustum should be culled. |
- Returns
- true if the setting is valid, false otherwise.
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_state | Whether to use vector culling. |
out_vector | The reference vector to compare the view vector to. |
- Returns
- true if the setting is valid, false otherwise.
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_degrees | The upper limit, in degrees, between the reference vector and the view vector. |
- Returns
- true if the setting is valid, false otherwise.
Removes the back face culling setting.
- Returns
- A reference to this object.
CullingKit& HPS::CullingKit::UnsetDeferralExtent |
( |
| ) |
|
Removes the extent culling setting.
- Returns
- A reference to this object.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes the extent culling setting.
- Returns
- A reference to this object.
Removes the frustum culling setting.
- Returns
- A reference to this object.
Removes the vector culling setting while leaving the vector tolerance unmodified.
- Returns
- A reference to this object.
CullingKit& HPS::CullingKit::UnsetVectorTolerance |
( |
| ) |
|
Removes the vector culling tolerance setting only.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: