< Home

< Table of Contents

REFERENCE MANUAL

HPS.CullingControl Class Reference

The CullingControl class is a smart pointer that is tied to a database object. More...

Inheritance diagram for HPS.CullingControl:
HPS.Control HPS.Object

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...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
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 ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

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.

Member Function Documentation

override HPS.Type HPS.CullingControl.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

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.

Parameters
in_stateWhether faces with normals that point away from the camera should be culled.
Returns
A reference to this object.
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.

Parameters
in_stateWhether deferral culling should be enabled.
in_pixelsThe number of pixels below which geometry should be deferred.
Returns
A reference to this object.
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.

Parameters
in_pixelsThe number of pixels below which geometry should be deferred.
Returns
A reference to this object.
HPS.CullingControl HPS.CullingControl.SetExtent ( bool  in_state,
uint  in_pixels 
)

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

Parameters
in_stateWhether extent culling should be enabled.
in_pixelsThe longest dimension of the screen-space projection of the bounding-volume, in pixels.
Returns
A reference to this object.
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.

Parameters
in_pixelsThe longest dimension of the screen-space projection of the bounding-volume, in pixels.
Returns
A reference to this object.
HPS.CullingControl HPS.CullingControl.SetFrustum ( bool  in_state)

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

Parameters
in_stateWhether geometry outside the current view frustum should be culled.
Returns
A reference to this object.
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.

Parameters
in_stateWhether to use vector culling.
in_vectorThe reference vector to compare the view vector to.
in_tolerance_degreesThe upper limit, in degrees, between the reference vector and the view vector.
Returns
A reference to this object.
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.

Parameters
in_vectorThe reference vector to compare the view vector to.
in_tolerance_degreesThe upper limit, in degrees, between the reference vector and the view vector.
Returns
A reference to this object.
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.

Parameters
in_stateWhether to use vector culling.
in_vectorThe reference vector to compare the view vector to.
Returns
A reference to this object.
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.

Parameters
in_stateWhether to use vector culling.
Returns
A reference to this object.
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.

Parameters
in_vectorThe reference vector to compare the view vector to.
Returns
A reference to this object.
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.

Parameters
in_tolerance_degreesThe upper limit, in degrees, between the reference vector and the view vector.
Returns
A reference to this object.
bool HPS.CullingControl.ShowBackFace ( out bool  out_state)

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

Parameters
out_stateWhether faces with normals that point away from the camera should be culled.
Returns
true if the setting is valid, false otherwise.
bool HPS.CullingControl.ShowDeferralExtent ( out bool  out_state,
out uint  out_pixels 
)

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

Parameters
out_stateWhether deferral culling should be enabled.
out_pixelsThe number of pixels below which geometry should be deferred.
Returns
true if the setting is valid, false otherwise.
bool HPS.CullingControl.ShowExtent ( out bool  out_state,
out uint  out_pixels 
)

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

Parameters
out_stateWhether extent culling should be enabled.
out_pixelsThe longest dimension of the screen-space projection of the bounding-volume, in pixels.
Returns
true if the setting is valid, false otherwise.
bool HPS.CullingControl.ShowFrustum ( out bool  out_state)

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

Parameters
out_stateWhether geometry outside the current view frustum should be culled.
Returns
true if the setting is valid, false otherwise.
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.

Parameters
out_stateWhether to use vector culling.
out_vectorThe reference vector to compare the view vector to.
Returns
true if the setting is valid, false otherwise.
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.

Parameters
out_tolerance_degreesThe upper limit, in degrees, between the reference vector and the view vector.
Returns
true if the setting is valid, false otherwise.
HPS.CullingControl HPS.CullingControl.UnsetBackFace ( )

Removes the back face culling setting.

Returns
A reference to this object.
HPS.CullingControl HPS.CullingControl.UnsetDeferralExtent ( )

Removes the extent culling setting.

Returns
A reference to this object.
HPS.CullingControl HPS.CullingControl.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
HPS.CullingControl HPS.CullingControl.UnsetExtent ( )

Removes the extent culling setting.

Returns
A reference to this object.
HPS.CullingControl HPS.CullingControl.UnsetFrustum ( )

Removes the frustum culling setting.

Returns
A reference to this object.
HPS.CullingControl HPS.CullingControl.UnsetVector ( )

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

Returns
A reference to this object.
HPS.CullingControl HPS.CullingControl.UnsetVectorTolerance ( )

Removes the vector culling tolerance setting only.

Returns
A reference to this object.

The documentation for this class was generated from the following file: