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. More...
Public Member Functions | |
override void | Dispose () |
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 HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. 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 | 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 | 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 | 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 | SetFrustum (bool in_state) |
Controls whether geometry outside the current view frustum should be culled. More... | |
HPS.CullingControl | UnsetDeferralExtent () |
Removes the extent culling setting. More... | |
HPS.CullingControl | UnsetExtent () |
Removes the extent culling setting. More... | |
HPS.CullingControl | UnsetBackFace () |
Removes the back face culling setting. More... | |
HPS.CullingControl | UnsetVector () |
Removes the vector culling setting while leaving the vector tolerance unmodified. More... | |
HPS.CullingControl | UnsetVectorTolerance () |
Removes the vector culling tolerance setting only. More... | |
HPS.CullingControl | UnsetFrustum () |
Removes the frustum culling setting. More... | |
HPS.CullingControl | UnsetEverything () |
Removes all settings from this object. 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 | ShowExtent (out bool out_state, out uint out_pixels) |
Shows whether geometry that falls below a certain size should be culled. More... | |
bool | ShowBackFace (out bool out_state) |
Shows whether faces with normals that point away from the camera 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 | ShowFrustum (out bool out_state) |
Shows whether geometry outside the current view frustum should be culled. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
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... | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
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.
in_state | Whether faces with normals that point away from the camera should be culled. |
|
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.
in_state | Whether deferral culling should be enabled. |
in_pixels | The number of pixels below which geometry should be deferred. |
|
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.
in_pixels | The number of pixels below which geometry should be deferred. |
|
inline |
Controls whether geometry that falls below a certain size should be culled.
in_state | Whether extent culling should be enabled. |
in_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
|
inline |
Controls whether geometry that falls below a certain size should be culled. This function implicitly enables extent culling.
in_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
|
inline |
Controls whether geometry outside the current view frustum should be culled.
in_state | Whether geometry outside the current view frustum should be culled. |
|
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.
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. |
|
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.
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. |
|
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.
in_state | Whether to use vector culling. |
in_vector | The reference vector to compare the view vector to. |
|
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.
in_state | Whether to use vector culling. |
|
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.
in_vector | The reference vector to compare the view vector to. |
|
inline |
Adjusts the tolerance value used in vector culling. This setting will have no effect is vector culling is not enabled.
in_tolerance_degrees | The upper limit, in degrees, between the reference vector and the view vector. |
|
inline |
Shows whether faces with normals that point away from the camera should be culled.
out_state | Whether faces with normals that point away from the camera should be culled. |
|
inline |
Shows whether geometry that falls below a certain size should be deferred.
out_state | Whether deferral culling should be enabled. |
out_pixels | The number of pixels below which geometry should be deferred. |
|
inline |
Shows whether geometry that falls below a certain size should be culled.
out_state | Whether extent culling should be enabled. |
out_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
|
inline |
Shows whether geometry outside the current view frustum should be culled.
out_state | Whether geometry outside the current view frustum should be culled. |
|
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.
out_state | Whether to use vector culling. |
out_vector | The reference vector to compare the view vector to. |
|
inline |
Shows the tolerance value used in vector culling. This setting will have no effect is vector culling is not enabled.
out_tolerance_degrees | The upper limit, in degrees, between the reference vector and the view vector. |
|
inline |
Removes the back face culling setting.
|
inline |
Removes the extent culling setting.
|
inline |
Removes all settings from this object.
|
inline |
Removes the extent culling setting.
|
inline |
Removes the frustum culling setting.
|
inline |
Removes the vector culling setting while leaving the vector tolerance unmodified.
|
inline |
Removes the vector culling tolerance setting only.