REFERENCE MANUAL
The CullingControl class is a smart pointer that is tied to a database object. More...
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. More... | |
HPS.CullingControl | SetBackFace (bool in_state) |
Controls whether faces with normals that point away from the camera should be culled. More... | |
HPS.CullingControl | SetDeferralExtent (bool in_state, uint in_pixels) |
Controls whether geometry that falls below a certain size should be deferred. More... | |
HPS.CullingControl | SetDeferralExtent (uint in_pixels) |
Controls whether geometry that falls below a certain size should be deferred. 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. 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. More... | |
HPS.CullingControl | SetVector (HPS.Vector in_vector, float in_tolerance_degrees) |
Controls the state of vector culling. More... | |
HPS.CullingControl | SetVector (bool in_state, HPS.Vector in_vector) |
Controls the state of vector culling. More... | |
HPS.CullingControl | SetVector (bool in_state) |
Controls the state of vector culling. More... | |
HPS.CullingControl | SetVector (HPS.Vector in_vector) |
Controls the state of vector culling. More... | |
HPS.CullingControl | SetVectorTolerance (float in_tolerance_degrees) |
Adjusts the tolerance value used in vector culling. 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 | 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. More... | |
bool | ShowVectorTolerance (out float out_tolerance_degrees) |
Shows the tolerance value used in vector culling. More... | |
HPS.CullingControl | UnsetBackFace () |
Removes the back face culling setting. More... | |
HPS.CullingControl | UnsetDeferralExtent () |
Removes the extent culling setting. More... | |
HPS.CullingControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.CullingControl | UnsetExtent () |
Removes the extent culling setting. More... | |
HPS.CullingControl | UnsetFrustum () |
Removes the frustum 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... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The 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 CullingControl.
HPS.CullingControl.CullingControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.CullingControl.CullingControl | ( | HPS.CullingControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
virtual |
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.
HPS.CullingControl 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.
in_state | Whether faces with normals that point away from the camera should be culled. |
HPS.CullingControl 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.
in_state | Whether deferral culling should be enabled. |
in_pixels | The number of pixels below which geometry should be deferred. |
HPS.CullingControl 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.
in_pixels | The number of pixels below which geometry should be deferred. |
HPS.CullingControl HPS.CullingControl.SetExtent | ( | bool | in_state, |
uint | in_pixels | ||
) |
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. |
HPS.CullingControl HPS.CullingControl.SetExtent | ( | uint | in_pixels | ) |
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. |
HPS.CullingControl HPS.CullingControl.SetFrustum | ( | bool | in_state | ) |
Controls whether geometry outside the current view frustum should be culled.
in_state | Whether geometry outside the current view frustum should be culled. |
HPS.CullingControl 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.
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. |
HPS.CullingControl 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.
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. |
HPS.CullingControl 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.
in_state | Whether to use vector culling. |
in_vector | The reference vector to compare the view vector to. |
HPS.CullingControl 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.
in_state | Whether to use vector culling. |
HPS.CullingControl 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.
in_vector | The reference vector to compare the view vector to. |
HPS.CullingControl 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.
in_tolerance_degrees | The upper limit, in degrees, between the reference vector and the view vector. |
bool HPS.CullingControl.ShowBackFace | ( | out bool | out_state | ) |
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. |
bool HPS.CullingControl.ShowDeferralExtent | ( | out bool | out_state, |
out uint | out_pixels | ||
) |
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. |
bool HPS.CullingControl.ShowExtent | ( | out bool | out_state, |
out uint | out_pixels | ||
) |
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. |
bool HPS.CullingControl.ShowFrustum | ( | out bool | out_state | ) |
Shows whether geometry outside the current view frustum should be culled.
out_state | Whether geometry outside the current view frustum should be culled. |
bool HPS.CullingControl.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.
out_state | Whether to use vector culling. |
out_vector | The reference vector to compare the view vector to. |
bool HPS.CullingControl.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.
out_tolerance_degrees | The upper limit, in degrees, between the reference vector and the view vector. |
HPS.CullingControl HPS.CullingControl.UnsetBackFace | ( | ) |
Removes the back face culling setting.
HPS.CullingControl HPS.CullingControl.UnsetDeferralExtent | ( | ) |
Removes the extent culling setting.
HPS.CullingControl HPS.CullingControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.CullingControl HPS.CullingControl.UnsetExtent | ( | ) |
Removes the extent culling setting.
HPS.CullingControl HPS.CullingControl.UnsetFrustum | ( | ) |
Removes the frustum culling setting.
HPS.CullingControl HPS.CullingControl.UnsetVector | ( | ) |
Removes the vector culling setting while leaving the vector tolerance unmodified.
HPS.CullingControl HPS.CullingControl.UnsetVectorTolerance | ( | ) |
Removes the vector culling tolerance setting only.