|
| CullingKit () |
|
| CullingKit (HPS.CullingKit in_kit) |
|
override void | Dispose () |
|
override bool | Empty () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.CullingKit in_kit) |
|
override int | GetHashCode () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.CullingKit in_kit) |
|
HPS.CullingKit | SetBackFace (bool in_state) |
|
HPS.CullingKit | SetDeferralExtent (bool in_state, uint in_pixels) |
|
HPS.CullingKit | SetDeferralExtent (uint in_pixels) |
|
HPS.CullingKit | SetDistance (bool in_state, float in_max_distance) |
|
HPS.CullingKit | SetDistance (float in_max_distance) |
|
HPS.CullingKit | SetExtent (bool in_state, uint in_pixels) |
|
HPS.CullingKit | SetExtent (uint in_pixels) |
|
HPS.CullingKit | SetFace (HPS.Culling.Face in_state) |
|
HPS.CullingKit | SetFrustum (bool in_state) |
|
HPS.CullingKit | SetVector (bool in_state, HPS.Vector in_vector, float in_tolerance_degrees) |
|
HPS.CullingKit | SetVector (HPS.Vector in_vector, float in_tolerance_degrees) |
|
HPS.CullingKit | SetVector (bool in_state, HPS.Vector in_vector) |
|
HPS.CullingKit | SetVector (bool in_state) |
|
HPS.CullingKit | SetVector (HPS.Vector in_vector) |
|
HPS.CullingKit | SetVectorTolerance (float in_tolerance_degrees) |
|
HPS.CullingKit | SetVolume (bool in_state, HPS.SimpleCuboid in_volume) |
|
HPS.CullingKit | SetVolume (bool in_state) |
|
HPS.CullingKit | SetVolume (HPS.SimpleCuboid in_volume) |
|
void | Show (out HPS.CullingKit out_kit) |
|
bool | ShowBackFace (out bool out_state) |
|
bool | ShowDeferralExtent (out bool out_state, out uint out_pixels) |
|
bool | ShowDistance (out bool out_state, out float out_max_distance) |
|
bool | ShowExtent (out bool out_state, out uint out_pixels) |
|
bool | ShowFace (out HPS.Culling.Face out_state) |
|
bool | ShowFrustum (out bool out_state) |
|
bool | ShowVector (out bool out_state, out HPS.Vector out_vector) |
|
bool | ShowVectorTolerance (out float out_tolerance_degrees) |
|
bool | ShowVolume (out bool out_state, out HPS.SimpleCuboid out_volume) |
|
HPS.CullingKit | UnsetBackFace () |
|
HPS.CullingKit | UnsetDeferralExtent () |
|
HPS.CullingKit | UnsetDistance () |
|
HPS.CullingKit | UnsetEverything () |
|
HPS.CullingKit | UnsetExtent () |
|
HPS.CullingKit | UnsetFace () |
|
HPS.CullingKit | UnsetFrustum () |
|
HPS.CullingKit | UnsetVector () |
|
HPS.CullingKit | UnsetVectorTolerance () |
|
HPS.CullingKit | UnsetVolume () |
|
override void | Dispose () |
|
| Kit (HPS.Kit in_that) |
|
override HPS.Type | ObjectType () |
|
override HPS.Type | Type () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.CullingKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.CullingKit.GetDefault() will return a kit with values found in this table.
◆ CullingKit() [1/2]
HPS.CullingKit.CullingKit |
( |
| ) |
|
|
inline |
Initializes an empty kit.
◆ CullingKit() [2/2]
The copy constructor creates a new CullingKit object that contains the same settings as the source object.
- Parameters
-
in_kit | The source object to copy. |
◆ Empty()
override bool HPS.CullingKit.Empty |
( |
| ) |
|
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
Check if the source CullingKit is equivalent to this object.
- Parameters
-
in_kit | The source CullingKit to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
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.
- Returns
- A CullingKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.CullingKit.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.Object.
◆ Set()
Copies all settings from the source CullingKit into this object.
- Parameters
-
◆ SetBackFace()
Controls whether faces with normals that point away from the camera should be culled.
- Deprecated:
- This function exists for compatibility. Use SetFace instead.
- 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]
HPS.CullingKit HPS.CullingKit.SetDeferralExtent |
( |
bool |
in_state, |
|
|
uint |
in_pixels |
|
) |
| |
|
inline |
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.
- Parameters
-
in_state | Whether deferral culling should be enabled. |
in_pixels | The number of pixels below which geometry should be culled with deferral. |
- Returns
- A reference to this object.
◆ SetDeferralExtent() [2/2]
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.
- Parameters
-
in_pixels | The number of pixels below which geometry should be culled with deferral. |
- Returns
- A reference to this object.
◆ SetDistance() [1/2]
HPS.CullingKit HPS.CullingKit.SetDistance |
( |
bool |
in_state, |
|
|
float |
in_max_distance |
|
) |
| |
|
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]
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]
HPS.CullingKit HPS.CullingKit.SetExtent |
( |
bool |
in_state, |
|
|
uint |
in_pixels |
|
) |
| |
|
inline |
Controls whether geometry that falls below a certain size in pixels 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]
Controls whether geometry that falls below a certain size in pixels 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.
◆ SetFace()
Controls whether faces with normals that point away from the camera or with normals that point toward should be culled.
- Parameters
-
in_state | Whether faces with normals that point away from the camera or with normals that point toward should be culled. |
- Returns
- A reference to this object.
◆ SetFrustum()
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]
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]
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]
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]
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]
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()
HPS.CullingKit HPS.CullingKit.SetVectorTolerance |
( |
float |
in_tolerance_degrees | ) |
|
|
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]
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]
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]
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.
◆ Show()
◆ ShowBackFace()
bool HPS.CullingKit.ShowBackFace |
( |
out bool |
out_state | ) |
|
|
inline |
Shows whether faces with normals that point away from the camera should be culled.
- Deprecated:
- This function exists for compatibility. Use ShowFace instead.
- 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()
bool HPS.CullingKit.ShowDeferralExtent |
( |
out bool |
out_state, |
|
|
out uint |
out_pixels |
|
) |
| |
|
inline |
Shows whether geometry that falls below a certain size should be culled with deferral.
- Parameters
-
out_state | Whether deferral culling should be enabled. |
out_pixels | The longest dimension of the screen-space projection of the bounding-volume, in pixels. |
- Returns
- A reference to this object.
◆ ShowDistance()
bool HPS.CullingKit.ShowDistance |
( |
out bool |
out_state, |
|
|
out float |
out_max_distance |
|
) |
| |
|
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()
bool HPS.CullingKit.ShowExtent |
( |
out bool |
out_state, |
|
|
out uint |
out_pixels |
|
) |
| |
|
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.
◆ ShowFace()
Shows whether faces with normals that point away from the camera or towards the camera should be culled.
- Parameters
-
out_state | Whether faces with normals that point away from the camera or towards the camera should be culled. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowFrustum()
bool HPS.CullingKit.ShowFrustum |
( |
out bool |
out_state | ) |
|
|
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()
bool HPS.CullingKit.ShowVector |
( |
out bool |
out_state, |
|
|
out HPS.Vector |
out_vector |
|
) |
| |
|
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()
bool HPS.CullingKit.ShowVectorTolerance |
( |
out float |
out_tolerance_degrees | ) |
|
|
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()
bool HPS.CullingKit.ShowVolume |
( |
out bool |
out_state, |
|
|
out HPS.SimpleCuboid |
out_volume |
|
) |
| |
|
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.
◆ UnsetBackFace()
Removes the back face culling setting.
- Deprecated:
- This function exists for compatibility. Use SetFace instead.
- Returns
- A reference to this object.
◆ UnsetDeferralExtent()
Removes the extent culling setting.
- Returns
- A reference to this object.
◆ UnsetDistance()
Removes the distance culling setting.
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetExtent()
Removes the extent culling setting.
- Returns
- A reference to this object.
◆ UnsetFace()
Removes the face culling setting.
- Returns
- A reference to this object.
◆ UnsetFrustum()
Removes the frustum culling setting.
- Returns
- A reference to this object.
◆ UnsetVector()
Removes the vector culling setting while leaving the vector tolerance unmodified.
- Returns
- A reference to this object.
◆ UnsetVectorTolerance()
Removes the vector culling tolerance setting only.
- Returns
- A reference to this object.
◆ UnsetVolume()
Removes the volume culling setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.CullingKit.cs