
Public Member Functions | |
CullingControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
CullingControl (HPS.CullingControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
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). More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
HPS.CullingControl | SetExtent (bool in_state, uint in_pixels) |
Controls whether geometry that falls below a certain size should be culled. More... | |
HPS.CullingControl | SetExtent (uint in_pixels) |
Controls whether geometry that falls below a certain size should be culled. This function implicitly enables extent culling. More... | |
HPS.CullingControl | SetFrustum (bool in_state) |
Controls whether geometry outside the current view frustum should be culled. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
bool | ShowBackFace (out bool out_state) |
Shows whether faces with normals that point away from the camera should be culled. More... | |
bool | ShowDeferralExtent (out bool out_state, out uint out_pixels) |
Shows whether geometry that falls below a certain size should be deferred. More... | |
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. More... | |
bool | ShowExtent (out bool out_state, out uint out_pixels) |
Shows whether geometry that falls below a certain size should be culled. More... | |
bool | ShowFrustum (out bool out_state) |
Shows whether geometry outside the current view frustum should be culled. More... | |
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. More... | |
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. More... | |
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. More... | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
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(). More... | |
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(). More... | |
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(). More... | |
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(). More... | |
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(). More... | |
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(). More... | |
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(). More... | |
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(). More... | |
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(). More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
◆ CullingControl() [1/2]
|
inline |
Initializes a control tied to the segment in_seg.
◆ CullingControl() [2/2]
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
◆ ObjectType()
|
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.Control.
◆ SetBackFace()
|
inline |
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.
- Parameters
-
in_state Whether faces with normals that point away from the camera should be culled.
- Returns
- A reference to this object.
◆ SetDeferralExtent() [1/2]
|
inline |
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.
◆ SetDeferralExtent() [2/2]
|
inline |
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_pixels The number of pixels below which geometry should be deferred.
- Returns
- A reference to this object.
◆ SetDistance() [1/2]
|
inline |
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.
◆ SetDistance() [2/2]
|
inline |
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.
◆ SetExtent() [1/2]
|
inline |
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.
◆ SetExtent() [2/2]
|
inline |
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.
◆ SetFrustum()
|
inline |
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.
◆ SetVector() [1/5]
|
inline |
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.
◆ SetVector() [2/5]
|
inline |
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.
◆ SetVector() [3/5]
|
inline |
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.
◆ SetVector() [4/5]
|
inline |
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.
- Returns
- A reference to this object.
◆ SetVector() [5/5]
|
inline |
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.
◆ SetVectorTolerance()
|
inline |
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.
◆ SetVolume() [1/3]
|
inline |
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.
◆ SetVolume() [2/3]
|
inline |
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.
- Returns
- A reference to this object.
◆ SetVolume() [3/3]
|
inline |
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.
◆ ShowBackFace()
|
inline |
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.
◆ ShowDeferralExtent()
|
inline |
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.
◆ ShowDistance()
|
inline |
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.
◆ ShowExtent()
|
inline |
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.
◆ ShowFrustum()
|
inline |
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.
◆ ShowVector()
|
inline |
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.
◆ ShowVectorTolerance()
|
inline |
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.
◆ ShowVolume()
|
inline |
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.
◆ Type()
|
inlinevirtual |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
◆ UnsetBackFace()
|
inline |
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().
- Returns
- A reference to this object.
◆ UnsetDeferralExtent()
|
inline |
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.
◆ UnsetDistance()
|
inline |
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.
◆ UnsetEverything()
|
inline |
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.
◆ UnsetExtent()
|
inline |
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.
◆ UnsetFrustum()
|
inline |
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.
◆ UnsetVector()
|
inline |
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.
◆ UnsetVectorTolerance()
|
inline |
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.
◆ UnsetVolume()
|
inline |
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.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.CullingControl.cs