CullingKit

class HPS.CullingKit : HPS.Kit

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.

Public Functions

CullingKit ()

Initializes an empty kit.

CullingKit (HPS.CullingKit in_kit)

The copy constructor creates a new CullingKit object that contains the same settings as the source object.

Param in_kit:The source object to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return:true if no values are set on this object, false otherwise.

bool Equals (HPS.CullingKit in_kit)

Check if the source CullingKit is equivalent to this object.

Param in_kit:The source CullingKit to compare to this object. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

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).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.CullingKit in_kit)

Copies all settings from the source CullingKit into this object.

Param in_kit:The source CullingKit to copy.

HPS.CullingKit SetBackFace (bool in_state)

Controls whether faces with normals that point away from the camera should be culled.

Deprecated:

This function exists for compatibility. Use SetFace instead.

Param in_state:Whether faces with normals that point away from the camera should be culled. Return:A reference to this object.

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.

Param in_state:Whether deferral culling should be enabled. Param in_pixels:  The number of pixels below which geometry should be culled with deferral. Return:A reference to this object.

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.

Param in_pixels:  The number of pixels below which geometry should be culled with deferral. Return:A reference to this object.

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.

Param in_state:Whether to use distance culling. Param in_max_distance:  The maximum distance from the camera after which geometries will be culled. Return:A reference to this object.

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.

Param in_max_distance:  The maximum distance from the camera after which geometries will be culled. Return:A reference to this object.

HPS.CullingKit SetExtent (bool in_state, uint in_pixels)

Controls whether geometry that falls below a certain size in pixels should be culled.

Param in_state:Whether extent culling should be enabled. Param in_pixels:  The longest dimension of the screen-space projection of the bounding-volume, in pixels. Return:A reference to this object.

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.

Param in_pixels:  The longest dimension of the screen-space projection of the bounding-volume, in pixels. Return:A reference to this object.

HPS.CullingKit SetFace (HPS.Culling.Face in_state)

Controls whether faces with normals that point away from the camera or with normals that point toward should be culled.

Param in_state:Whether faces with normals that point away from the camera or with normals that point toward should be culled. Return:A reference to this object.

HPS.CullingKit SetFrustum (bool in_state)

Controls whether geometry outside the current view frustum should be culled.

Param in_state:Whether geometry outside the current view frustum should be culled. Return:A reference to this object.

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.

Param in_state:Whether to use vector culling. Return:A reference to this object.

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.

Param in_state:Whether to use vector culling. Param in_vector:  The reference vector to compare the view vector to. Return:A reference to this object.

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.

Param in_state:Whether to use vector culling. Param in_vector:  The reference vector to compare the view vector to. Param in_tolerance_degrees:  The upper limit, in degrees, between the reference vector and the view vector. Return:A reference to this object.

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.

Param in_vector:  The reference vector to compare the view vector to. Return:A reference to this object.

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.

Param in_vector:  The reference vector to compare the view vector to. Param in_tolerance_degrees:  The upper limit, in degrees, between the reference vector and the view vector. Return:A reference to this object.

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.

Param in_tolerance_degrees:  The upper limit, in degrees, between the reference vector and the view vector. Return:A reference to this object.

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.

Param in_state:Whether to use volume culling. Return:A reference to this object.

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.

Param in_state:Whether to use volume culling. Param in_volume:  A cuboid used to describe a world-space volume. Return:A reference to this object.

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.

Param in_volume:  A cuboid used to describe a world-space volume. Return:A reference to this object.

void Show (out HPS.CullingKit out_kit)

Copies all settings from this CullingKit into the given CullingKit.

Param out_kit:The CullingKit to populate with the contents of this object.

bool ShowBackFace (out bool out_state)

Shows whether faces with normals that point away from the camera should be culled.

Deprecated:

This function exists for compatibility. Use ShowFace instead.

Param out_state:  Whether faces with normals that point away from the camera should be culled. Return:true if the setting is valid, false otherwise.

bool ShowDeferralExtent (out bool out_state, out uint out_pixels)

Shows whether geometry that falls below a certain size should be culled with deferral.

Param out_state:  Whether deferral culling should be enabled. Param out_pixels:  The longest dimension of the screen-space projection of the bounding-volume, in pixels. Return:A reference to this object.

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.

Param out_state:  Whether distance culling is being used. Param out_max_distance:  The maximum distance away from the camera before geometries are culled. Return:true if the setting is valid, false otherwise.

bool ShowExtent (out bool out_state, out uint out_pixels)

Shows whether geometry that falls below a certain size should be culled.

Param out_state:  Whether extent culling should be enabled. Param out_pixels:  The longest dimension of the screen-space projection of the bounding-volume, in pixels. Return:true if the setting is valid, false otherwise.

bool ShowFace (out HPS.Culling.Face out_state)

Shows whether faces with normals that point away from the camera or towards the camera should be culled.

Param out_state:  Whether faces with normals that point away from the camera or towards the camera should be culled. Return:true if the setting is valid, false otherwise.

bool ShowFrustum (out bool out_state)

Shows whether geometry outside the current view frustum should be culled.

Param out_state:  Whether geometry outside the current view frustum should be culled. Return:true if the setting is valid, false otherwise.

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.

Param out_state:  Whether to use vector culling. Param out_vector:  The reference vector to compare the view vector to. Return:true if the setting is valid, false otherwise.

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.

Param out_tolerance_degrees:  The upper limit, in degrees, between the reference vector and the view vector. Return:true if the setting is valid, false otherwise.

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.

Param out_state:  Whether volume culling is being used. Param out_volume:  A cuboid defining a world-space volume. Return:true if the setting is valid, false otherwise.

HPS.CullingKit UnsetBackFace ()

Removes the back face culling setting.

Deprecated:

This function exists for compatibility. Use SetFace instead.

Return:A reference to this object.

HPS.CullingKit UnsetDeferralExtent ()

Removes the extent culling setting.

Return:A reference to this object.

HPS.CullingKit UnsetDistance ()

Removes the distance culling setting.

Return:A reference to this object.

HPS.CullingKit UnsetEverything ()

Removes all settings from this object.

Return:A reference to this object.

HPS.CullingKit UnsetExtent ()

Removes the extent culling setting.

Return:A reference to this object.

HPS.CullingKit UnsetFace ()

Removes the face culling setting.

Return:A reference to this object.

HPS.CullingKit UnsetFrustum ()

Removes the frustum culling setting.

Return:A reference to this object.

HPS.CullingKit UnsetVector ()

Removes the vector culling setting while leaving the vector tolerance unmodified.

Return:A reference to this object.

HPS.CullingKit UnsetVectorTolerance ()

Removes the vector culling tolerance setting only.

Return:A reference to this object.

HPS.CullingKit UnsetVolume ()

Removes the volume culling setting.

Return:A reference to this object.

Public Static Functions

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.

Return:A CullingKit with the default settings.

bool operator!= (HPS.CullingKit a, HPS.CullingKit b)

bool operator== (HPS.CullingKit a, HPS.CullingKit b)