
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 (if the object is derived, this does not give the true type of the derived object). 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. Deferral culling means the object is given a low-priority draw order, effectively delaying draw time until the end of the frame. More... | |
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. More... | |
HPS.CullingKit | 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.CullingKit | 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.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. This function implicitly enables extent culling. 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. 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.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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
HPS.CullingKit | 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.CullingKit | 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.CullingKit | 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... | |
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 | 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... | |
HPS.CullingKit | UnsetBackFace () |
Removes the back face culling setting. More... | |
HPS.CullingKit | UnsetDeferralExtent () |
Removes the extent culling setting. More... | |
HPS.CullingKit | UnsetDistance () |
Removes the distance 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... | |
HPS.CullingKit | UnsetVolume () |
Removes the volume culling setting. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
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... | |
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... | |
![]() | |
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... | |
Static Public Member Functions | |
static HPS.CullingKit | 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. 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 () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
◆ CullingKit() [1/2]
|
inline |
Initializes an empty kit.
◆ CullingKit() [2/2]
|
inline |
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.
Member Function Documentation
◆ 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()
|
inline |
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()
|
inlinestatic |
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()
|
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()
|
inline |
Copies all settings from the source CullingKit into this object.
- Parameters
-
in_kit The source CullingKit to copy.
◆ SetBackFace()
|
inline |
Controls whether faces with normals that point away from the camera should be culled.
- 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 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]
|
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. 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]
|
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 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]
|
inline |
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.
◆ 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.
◆ Show()
|
inline |
Copies all settings from this CullingKit into the given CullingKit.
- Parameters
-
out_kit The CullingKit to populate with the contents of 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 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()
|
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.
◆ UnsetBackFace()
|
inline |
Removes the back face culling setting.
- Returns
- A reference to this object.
◆ UnsetDeferralExtent()
|
inline |
Removes the extent culling setting.
- Returns
- A reference to this object.
◆ UnsetDistance()
|
inline |
Removes the distance culling setting.
- Returns
- A reference to this object.
◆ UnsetEverything()
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetExtent()
|
inline |
Removes the extent culling setting.
- Returns
- A reference to this object.
◆ UnsetFrustum()
|
inline |
Removes the frustum culling setting.
- Returns
- A reference to this object.
◆ UnsetVector()
|
inline |
Removes the vector culling setting while leaving the vector tolerance unmodified.
- Returns
- A reference to this object.
◆ UnsetVectorTolerance()
|
inline |
Removes the vector culling tolerance setting only.
- Returns
- A reference to this object.
◆ UnsetVolume()
|
inline |
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