CullingKit

class HPS::CullingKit : public HPS::Kit 

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.

Public Functions

CullingKit(): Initializes an empty kit.

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.

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.

virtual bool Empty() const

Indicates whether this object has any values set on it.

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

bool 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.

inline virtual HPS::Type ObjectType() const

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.

bool 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.

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_that – An rvalue reference to a CullingKit to take the impl from.
Returns: A reference to this CullingKit.

CullingKit &operator=(CullingKit const &in_kit)

Copies the source CullingKit into this object.

Parameters: in_kit – The source CullingKit to copy.
Returns: A reference to this object.

bool 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 Set(CullingKit const &in_kit)

Copies all settings from the source CullingKit into this object.

Parameters: in_kit – The source CullingKit to copy.

CullingKit &SetBackFace(bool in_state)

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

Deprecated:: This function exists for compatibility. Use SetFace instead.

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

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 &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 &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_state – Whether to use distance culling.
in_max_distance – The maximum distance from the camera after which geometries will be culled.

Returns

A reference to this object.

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_distance – The maximum distance from the camera after which geometries will be culled.
Returns: A reference to this object.

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 &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 &SetFace(Culling::Face in_state)

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

Parameters: in_state – Whether faces with normals that point away from the camera or with normals that point toward should be culled.
Returns: A reference to this object.

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 &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.

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_state – Whether to use vector culling.
in_vector – The reference vector to compare the view vector to.

Returns

A reference to this object.

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_vector – The reference vector to compare the view vector to.
Returns: A reference to this object.

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_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.

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.

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_state – Whether to use volume culling.
in_volume – A cuboid used to describe a world-space volume.

Returns

A reference to this object.

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_volume – A cuboid used to describe a world-space volume.
Returns: A reference to this object.

void Show(CullingKit &out_kit) const

Copies all settings from this CullingKit into the given CullingKit.

Parameters: out_kit – The CullingKit to populate with the contents of this object.

bool ShowBackFace(bool &out_state) const

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

Deprecated:: This function exists for compatibility. Use ShowFace instead.

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 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 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_state – Whether distance culling is being used.
out_max_distance – The maximum distance away from the camera before geometries are culled.

Returns

true if the setting is valid, false otherwise.

bool 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 ShowFace(Culling::Face &out_state) const

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

Parameters: out_state – Whether faces with normals that point away from the camera or towards the camera should be culled.
Returns: true if the setting is valid, false otherwise.

bool 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 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 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.

bool 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_state – Whether volume culling is being used.
out_volume – A cuboid defining a world-space volume.

Returns

true if the setting is valid, false otherwise.

CullingKit &UnsetBackFace()

Removes the back face culling setting.

Deprecated:: This function exists for compatibility. Use SetFace instead.

Returns: A reference to this object.

CullingKit &UnsetDeferralExtent()

Removes the extent culling setting.

Returns: A reference to this object.

CullingKit &UnsetDistance()

Removes the distance culling setting.

Returns: A reference to this object.

CullingKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

CullingKit &UnsetExtent()

Removes the extent culling setting.

Returns: A reference to this object.

CullingKit &UnsetFace()

Removes the face culling setting.

Returns: A reference to this object.

CullingKit &UnsetFrustum()

Removes the frustum culling setting.

Returns: A reference to this object.

CullingKit &UnsetVector()

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

Returns: A reference to this object.

CullingKit &UnsetVectorTolerance()

Removes the vector culling tolerance setting only.

Returns: A reference to this object.

CullingKit &UnsetVolume()

Removes the volume culling setting.

Returns: A reference to this object.

virtual ~CullingKit(): Destroy this kit.

Public Static Functions

static CullingKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CullingKit