CullingControl

class CullingControl : public HPS::Control

The HPS::CullingControl class is a smart pointer that is tied to a database object. Using this object, you are able to control the various options related to culling, such as enabling or disabling back face culling, vector culling, and frustum culling. This table lists default values for the various segment attributes accessible from HPS::CullingControl.

Public Functions

CullingControl(CullingControl &&in_that)

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

Parameters:

in_that – An rvalue reference to a CullingControl to take the impl from.

CullingControl(CullingControl const &in_that)

Initializes a control tied to the same object as in_that.

explicit CullingControl(SegmentKey &in_seg)

Initializes a control tied to the segment in_seg.

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.

CullingControl &operator=(CullingControl &&in_that)

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

Parameters:

in_that – An rvalue reference to a CullingControl to take the impl from.

Returns:

A reference to this CullingControl.

CullingControl &operator=(CullingControl const &in_that)

Share the underlying smart-pointer of the CullingControl source.

Parameters:

in_that – The CullingControl source of the assignment.

Returns:

A reference to this CullingControl.

CullingControl &SetBackFace(bool in_state)

Controls whether faces with normals that point away from the camera should be culled. This option can only be effective if a polygon handedness is defined.

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.

CullingControl &SetDeferralExtent(bool in_state, unsigned int in_pixels)

Controls whether geometry that falls below a certain size should be deferred. This setting only becomes relevant in timed updates (or fixed-framerate) when deferred geometry is given a lower priority. During non-timed updates no geometry is deferred, regardless of this setting.

Parameters:

  • in_state – Whether deferral culling should be enabled.

  • in_pixels – The number of pixels below which geometry should be deferred.

Returns:

A reference to this object.

CullingControl &SetDeferralExtent(unsigned int in_pixels)

Controls whether geometry that falls below a certain size should be deferred. This setting only becomes relevant in timed updates (or fixed-framerate) when deferred geometry is given a lower priority. During non-timed updates no geometry is deferred, regardless of this setting.

Parameters:

  • in_state – Whether deferral culling should be enabled.

  • in_pixels – The number of pixels below which geometry should be deferred.

Returns:

A reference to this object.

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

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

CullingControl &SetExtent(bool in_state, unsigned int in_pixels)

Controls whether geometry that falls below a certain size 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.

CullingControl &SetExtent(unsigned int in_pixels)

Controls whether geometry that falls below a certain size 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.

CullingControl &SetFace(Culling::Face in_state)

Controls whether faces with normals that point away from the camera or with normals that point toward the camera should be culled. This option can only be effective if a polygon handedness is defined.

Parameters:

in_state – Whether faces with normals that point away from the camera or with normals that point toward the camera should be culled.

Returns:

A reference to this object.

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

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

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

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

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

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

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

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

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

Parameters:

  • out_state – Whether deferral culling should be enabled.

  • out_pixels – The number of pixels below which geometry should be deferred.

Returns:

true if the setting is valid, false otherwise.

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 if faces with normals that point away or normals that point toward 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.

CullingControl &UnsetBackFace()

Removes the back face culling setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Deprecated:

This function exists for compatibility. Use UnsetFace instead.

Returns:

A reference to this object.

CullingControl &UnsetDeferralExtent()

Removes the extent culling setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

CullingControl &UnsetDistance()

Removes the distance culling setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

CullingControl &UnsetEverything()

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

CullingControl &UnsetExtent()

Removes the extent culling setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

CullingControl &UnsetFace()

Removes the face culling setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

CullingControl &UnsetFrustum()

Removes the frustum culling setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

CullingControl &UnsetVector()

Removes the vector culling setting while leaving the vector tolerance unmodified. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

CullingControl &UnsetVectorTolerance()

Removes the vector culling tolerance setting only. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

CullingControl &UnsetVolume()

Removes the volume culling setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Returns:

A reference to this object.

~CullingControl()

Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CullingControl