CullingControl

class HPS.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 (HPS.CullingControl in_that): Initializes a control tied to the same object as in_that.

CullingControl (HPS.SegmentKey in_seg): Initializes a control tied to the segment in_seg.

override void Dispose ()

override HPS.Type ObjectType ()

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

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

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

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

HPS.CullingControl SetDeferralExtent (bool in_state, uint 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.

Param in_state: Whether deferral culling should be enabled.
Param in_pixels: The number of pixels below which geometry should be deferred.
Return: A reference to this object.

HPS.CullingControl SetDeferralExtent (uint 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.

Param in_pixels: The number of pixels below which geometry should be deferred.
Return: A reference to this object.

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

Param in_state: Whether to use distance culling.
Param in_max_distance: The maximum distance from the camera after which geometries will be culled.
Return: A reference to this object.

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

Param in_max_distance: The maximum distance from the camera after which geometries will be culled.
Return: A reference to this object.

HPS.CullingControl SetExtent (bool in_state, uint in_pixels)

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

Param in_state: Whether extent culling should be enabled.
Param in_pixels: The longest dimension of the screen-space projection of the bounding-volume, in pixels.
Return: A reference to this object.

HPS.CullingControl SetExtent (uint in_pixels)

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

Param in_pixels: The longest dimension of the screen-space projection of the bounding-volume, in pixels.
Return: A reference to this object.

HPS.CullingControl SetFace (HPS.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.

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

HPS.CullingControl SetFrustum (bool in_state)

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

Param in_state: Whether geometry outside the current view frustum should be culled.
Return: A reference to this object.

HPS.CullingControl SetVector (bool in_state)

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.

Param in_state: Whether to use vector culling.
Return: A reference to this object.

HPS.CullingControl SetVector (bool in_state, HPS.Vector 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 does not modify the vector tolerance.

Param in_state: Whether to use vector culling.
Param in_vector: The reference vector to compare the view vector to.
Return: A reference to this object.

HPS.CullingControl SetVector (bool in_state, HPS.Vector 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.

Param in_state: Whether to use vector culling.
Param in_vector: The reference vector to compare the view vector to.
Param in_tolerance_degrees: The upper limit, in degrees, between the reference vector and the view vector.
Return: A reference to this object.

HPS.CullingControl SetVector (HPS.Vector 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.

Param in_vector: The reference vector to compare the view vector to.
Return: A reference to this object.

HPS.CullingControl SetVector (HPS.Vector 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.

Param in_vector: The reference vector to compare the view vector to.
Param in_tolerance_degrees: The upper limit, in degrees, between the reference vector and the view vector.
Return: A reference to this object.

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

Param in_tolerance_degrees: The upper limit, in degrees, between the reference vector and the view vector.
Return: A reference to this object.

HPS.CullingControl SetVolume (bool in_state)

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.

Param in_state: Whether to use volume culling.
Return: A reference to this object.

HPS.CullingControl SetVolume (bool in_state, HPS.SimpleCuboid 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.

Param in_state: Whether to use volume culling.
Param in_volume: A cuboid used to describe a world-space volume.
Return: A reference to this object.

HPS.CullingControl SetVolume (HPS.SimpleCuboid 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.

Param in_volume: A cuboid used to describe a world-space volume.
Return: A reference to this object.

bool ShowBackFace (out bool out_state)

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

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

Param out_state: Whether faces with normals that point away from the camera should be culled.
Return: true if the setting is valid, false otherwise.

bool ShowDeferralExtent (out bool out_state, out uint out_pixels)

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

Param out_state: Whether deferral culling should be enabled.
Param out_pixels: The number of pixels below which geometry should be deferred.
Return: true if the setting is valid, false otherwise.

bool ShowDistance (out bool out_state, out float out_max_distance)

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.

Param out_state: Whether distance culling is being used.
Param out_max_distance: The maximum distance away from the camera before geometries are culled.
Return: true if the setting is valid, false otherwise.

bool ShowExtent (out bool out_state, out uint out_pixels)

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

Param out_state: Whether extent culling should be enabled.
Param out_pixels: The longest dimension of the screen-space projection of the bounding-volume, in pixels.
Return: true if the setting is valid, false otherwise.

bool ShowFace (out HPS.Culling.Face out_state)

Shows if faces with normals that point away or normals that point toward the camera should be culled.

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

bool ShowFrustum (out bool out_state)

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

Param out_state: Whether geometry outside the current view frustum should be culled.
Return: true if the setting is valid, false otherwise.

bool ShowVector (out bool out_state, out HPS.Vector out_vector)

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.

Param out_state: Whether to use vector culling.
Param out_vector: The reference vector to compare the view vector to.
Return: true if the setting is valid, false otherwise.

bool ShowVectorTolerance (out float out_tolerance_degrees)

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

Param out_tolerance_degrees: The upper limit, in degrees, between the reference vector and the view vector.
Return: true if the setting is valid, false otherwise.

bool ShowVolume (out bool out_state, out HPS.SimpleCuboid out_volume)

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

Param out_state: Whether volume culling is being used.
Param out_volume: A cuboid defining a world-space volume.
Return: true if the setting is valid, false otherwise.

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

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.