REFERENCE MANUAL
The CullingKit class is a user space object, useful for carrying a group attribute settings. More...
Public Member Functions | |
CullingKit () | |
Initializes an empty kit. More... | |
CullingKit (HPS.CullingKit in_kit) | |
The copy constructor creates a new CullingKit object that contains the same settings as the source object. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CullingKit in_kit) |
Check if the source CullingKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.CullingKit in_kit) |
Copies all settings from the source CullingKit into this object. More... | |
HPS.CullingKit | SetBackFace (bool in_state) |
Controls whether faces with normals that point away from the camera should be culled. More... | |
HPS.CullingKit | SetDeferralExtent (bool in_state, uint in_pixels) |
Controls whether geometry that falls below a certain size in pixels should be culled with deferral. More... | |
HPS.CullingKit | SetDeferralExtent (uint in_pixels) |
Controls whether geometry that falls below a certain size in pixels should be culled with deferral. More... | |
HPS.CullingKit | SetExtent (bool in_state, uint in_pixels) |
Controls whether geometry that falls below a certain size in pixels should be culled. More... | |
HPS.CullingKit | SetExtent (uint in_pixels) |
Controls whether geometry that falls below a certain size in pixels should be culled. More... | |
HPS.CullingKit | SetFrustum (bool in_state) |
Controls whether geometry outside the current view frustum should be culled. More... | |
HPS.CullingKit | SetVector (bool in_state, HPS.Vector in_vector, float in_tolerance_degrees) |
Controls the state of vector culling. More... | |
HPS.CullingKit | SetVector (HPS.Vector in_vector, float in_tolerance_degrees) |
Controls the state of vector culling. More... | |
HPS.CullingKit | SetVector (bool in_state, HPS.Vector in_vector) |
Controls the state of vector culling. More... | |
HPS.CullingKit | SetVector (bool in_state) |
Controls the state of vector culling. More... | |
HPS.CullingKit | SetVector (HPS.Vector in_vector) |
Controls the state of vector culling. More... | |
HPS.CullingKit | SetVectorTolerance (float in_tolerance_degrees) |
Adjusts the tolerance value used in vector culling. More... | |
void | Show (out HPS.CullingKit out_kit) |
Copies all settings from this CullingKit into the given CullingKit. 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 culled with deferral. 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.CullingKit | UnsetBackFace () |
Removes the back face culling setting. More... | |
HPS.CullingKit | UnsetDeferralExtent () |
Removes the extent culling setting. More... | |
HPS.CullingKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.CullingKit | UnsetExtent () |
Removes the extent culling setting. More... | |
HPS.CullingKit | UnsetFrustum () |
Removes the frustum culling setting. More... | |
HPS.CullingKit | UnsetVector () |
Removes the vector culling setting while leaving the vector tolerance unmodified. More... | |
HPS.CullingKit | UnsetVectorTolerance () |
Removes the vector culling tolerance setting only. 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... | |
Static Public Member Functions | |
static HPS.CullingKit | GetDefault () |
Creates a CullingKit which contains the default settings. More... | |
static bool | operator!= (HPS.CullingKit a, HPS.CullingKit b) |
static bool | operator== (HPS.CullingKit a, HPS.CullingKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The CullingKit class is a user space object, useful for carrying a group attribute settings.
Calling CullingKit::GetDefault() will return a kit with values found in this table.
HPS.CullingKit.CullingKit | ( | ) |
Initializes an empty kit.
HPS.CullingKit.CullingKit | ( | HPS.CullingKit | in_kit | ) |
The copy constructor creates a new CullingKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
bool HPS.CullingKit.Equals | ( | HPS.CullingKit | in_kit | ) |
Check if the source CullingKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_culling_kit" kindref="compound">CullingKit</ref> to compare to this object. |
|
static |
Creates a CullingKit which contains the default settings.
The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
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.
void HPS.CullingKit.Set | ( | HPS.CullingKit | in_kit | ) |
Copies all settings from the source CullingKit into this object.
in_kit | The source <ref refid="class_h_p_s_1_1_culling_kit" kindref="compound">CullingKit</ref> to copy. |
HPS.CullingKit HPS.CullingKit.SetBackFace | ( | bool | in_state | ) |
Controls whether faces with normals that point away from the camera should be culled.
in_state | Whether faces with normals that point away from the camera should be culled. |
HPS.CullingKit HPS.CullingKit.SetDeferralExtent | ( | bool | in_state, |
uint | in_pixels | ||
) |
Controls whether geometry that falls below a certain size in pixels should be culled with deferral.
Deferral culling means the object is given a low-priority draw order, effectively delaying draw time until the end of the frame.
in_state | Whether deferral culling should be enabled. |
in_pixels | The number of pixels below which geometry should be culled with deferral. |
HPS.CullingKit HPS.CullingKit.SetDeferralExtent | ( | uint | in_pixels | ) |
Controls whether geometry that falls below a certain size in pixels should be culled with deferral.
Deferral culling means the object is given a low-priority draw order, effectively delaying draw time until the end of the frame. This function implicitly enables deferral extent culling.
in_pixels | The number of pixels below which geometry should be culled with deferral. |
HPS.CullingKit HPS.CullingKit.SetExtent | ( | bool | in_state, |
uint | in_pixels | ||
) |
Controls whether geometry that falls below a certain size in pixels 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.CullingKit HPS.CullingKit.SetExtent | ( | uint | in_pixels | ) |
Controls whether geometry that falls below a certain size in pixels 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.CullingKit HPS.CullingKit.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.CullingKit HPS.CullingKit.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.CullingKit HPS.CullingKit.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.CullingKit HPS.CullingKit.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.CullingKit HPS.CullingKit.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.CullingKit HPS.CullingKit.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.CullingKit HPS.CullingKit.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. |
void HPS.CullingKit.Show | ( | out HPS.CullingKit | out_kit | ) |
Copies all settings from this CullingKit into the given CullingKit.
out_kit | The <ref refid="class_h_p_s_1_1_culling_kit" kindref="compound">CullingKit</ref> to populate with the contents of this object. |
bool HPS.CullingKit.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.CullingKit.ShowDeferralExtent | ( | out bool | out_state, |
out uint | out_pixels | ||
) |
Shows whether geometry that falls below a certain size should be culled with deferral.
out_state | Whether deferral culling should be enabled. |
out_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
bool HPS.CullingKit.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.CullingKit.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.CullingKit.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.CullingKit.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.CullingKit HPS.CullingKit.UnsetBackFace | ( | ) |
Removes the back face culling setting.
HPS.CullingKit HPS.CullingKit.UnsetDeferralExtent | ( | ) |
Removes the extent culling setting.
HPS.CullingKit HPS.CullingKit.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.CullingKit HPS.CullingKit.UnsetExtent | ( | ) |
Removes the extent culling setting.
HPS.CullingKit HPS.CullingKit.UnsetFrustum | ( | ) |
Removes the frustum culling setting.
HPS.CullingKit HPS.CullingKit.UnsetVector | ( | ) |
Removes the vector culling setting while leaving the vector tolerance unmodified.
HPS.CullingKit HPS.CullingKit.UnsetVectorTolerance | ( | ) |
Removes the vector culling tolerance setting only.