The HPS::CullingKit class is a user space object, useful for carrying a group attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::CullingKit:

Collaboration diagram for HPS::CullingKit:

Public Member Functions
	CullingKit ()
	Initializes an empty kit. More...

	CullingKit (CullingKit const &in_kit)
	The copy constructor creates a new CullingKit object that contains the same settings as the source object. More...

	CullingKit (CullingKit &&in_that)
	The move constructor creates a CullingKit by transferring the underlying impl of the rvalue reference to this CullingKit thereby avoiding a copy and allocation. More...

CullingKit &	operator= (CullingKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CullingKit thereby avoiding a copy. More...

virtual	~CullingKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (CullingKit const &in_kit)
	Copies all settings from the source CullingKit into this object. More...

void	Show (CullingKit &out_kit) const
	Copies all settings from this CullingKit into the given CullingKit. More...

CullingKit &	operator= (CullingKit const &in_kit)
	Copies the source CullingKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (CullingKit const &in_kit) const
	Check if the source CullingKit is equivalent to this object. More...

bool	operator== (CullingKit const &in_kit) const
	Check if the source CullingKit is equivalent to this object. More...

bool	operator!= (CullingKit const &in_kit) const
	Check if the source CullingKit is not equivalent to this object. More...

CullingKit &	SetDeferralExtent (bool in_state, unsigned int in_pixels)
	Controls whether geometry that falls below a certain size in pixels should be culled with deferral. More...

CullingKit &	SetDeferralExtent (unsigned int in_pixels)
	Controls whether geometry that falls below a certain size in pixels should be culled with deferral. More...

CullingKit &	SetExtent (bool in_state, unsigned int in_pixels)
	Controls whether geometry that falls below a certain size in pixels should be culled. More...

CullingKit &	SetExtent (unsigned int in_pixels)
	Controls whether geometry that falls below a certain size in pixels should be culled. More...

CullingKit &	SetBackFace (bool in_state)
	Controls whether faces with normals that point away from the camera should be culled. More...

CullingKit &	SetVector (bool in_state, HPS::Vector const &in_vector, float in_tolerance_degrees)
	Controls the state of vector culling. More...

CullingKit &	SetVector (HPS::Vector const &in_vector, float in_tolerance_degrees)
	Controls the state of vector culling. More...

CullingKit &	SetVector (bool in_state, HPS::Vector const &in_vector=Vector(0.0f, 0.0f, 1.0f))
	Controls the state of vector culling. More...

CullingKit &	SetVector (HPS::Vector const &in_vector)
	Controls the state of vector culling. More...

CullingKit &	SetVectorTolerance (float in_tolerance_degrees)
	Adjusts the tolerance value used in vector culling. More...

CullingKit &	SetFrustum (bool in_state)
	Controls whether geometry outside the current view frustum should be culled. More...

CullingKit &	UnsetDeferralExtent ()
	Removes the extent culling setting. More...

CullingKit &	UnsetExtent ()
	Removes the extent culling setting. More...

CullingKit &	UnsetBackFace ()
	Removes the back face culling setting. More...

CullingKit &	UnsetVector ()
	Removes the vector culling setting while leaving the vector tolerance unmodified. More...

CullingKit &	UnsetVectorTolerance ()
	Removes the vector culling tolerance setting only. More...

CullingKit &	UnsetFrustum ()
	Removes the frustum culling setting. More...

CullingKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowDeferralExtent (bool &out_state, unsigned int &out_pixels) const
	Shows whether geometry that falls below a certain size should be culled with deferral. More...

bool	ShowExtent (bool &out_state, unsigned int &out_pixels) const
	Shows whether geometry that falls below a certain size should be culled. More...

bool	ShowBackFace (bool &out_state) const
	Shows whether faces with normals that point away from the camera should be culled. More...

bool	ShowVector (bool &out_state, HPS::Vector &out_vector) const
	Shows the state of vector culling. More...

bool	ShowVectorTolerance (float &out_tolerance_degrees) const
	Shows the tolerance value used in vector culling. More...

bool	ShowFrustum (bool &out_state) const
	Shows whether geometry outside the current view frustum should be culled. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static CullingKit	GetDefault ()
	Creates a CullingKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::CullingKit

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/3]

HPS::CullingKit::CullingKit ( )

Initializes an empty kit.

◆ CullingKit() [2/3]

HPS::CullingKit::CullingKit ( CullingKit const & in_kit )

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.

◆ CullingKit() [3/3]

HPS::CullingKit::CullingKit ( CullingKit && in_that )

The move constructor creates a CullingKit by transferring the underlying impl of the rvalue reference to this CullingKit thereby avoiding a copy and allocation.

Parameters

in_that An rvalue reference to a CullingKit to take the impl from.

◆ ~CullingKit()

virtual HPS::CullingKit::~CullingKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::CullingKit::Empty ( ) const

virtual

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

bool HPS::CullingKit::Equals ( CullingKit const & in_kit ) const

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.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static CullingKit HPS::CullingKit::GetDefault ( )

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.

Returns: A CullingKit with the default settings.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::CullingKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::CullingKit::operator!= ( CullingKit const & in_kit ) const

Check if the source CullingKit is not equivalent to this object.

Parameters

in_kit The source CullingKit to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

CullingKit& HPS::CullingKit::operator= ( CullingKit && in_that )

The move assignment operator transfers the underlying impl of the rvalue reference to this CullingKit thereby avoiding a copy.

Parameters

in_that An rvalue reference to a CullingKit to take the impl from.

Returns: A reference to this CullingKit.

◆ operator=() [2/2]

CullingKit& HPS::CullingKit::operator= ( CullingKit const & in_kit )

Copies the source CullingKit into this object.

Parameters

in_kit The source CullingKit to copy.

Returns: A reference to this object.

◆ operator==()

bool HPS::CullingKit::operator== ( CullingKit const & in_kit ) const

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.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

void HPS::CullingKit::Set ( CullingKit const & in_kit )

Copies all settings from the source CullingKit into this object.

Parameters

in_kit The source CullingKit to copy.

◆ SetBackFace()

CullingKit& HPS::CullingKit::SetBackFace ( bool in_state )

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]

CullingKit& HPS::CullingKit::SetDeferralExtent	(	bool	in_state,
		unsigned int	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.

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]

CullingKit& HPS::CullingKit::SetDeferralExtent ( unsigned int 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.

Parameters

in_pixels The number of pixels below which geometry should be culled with deferral.

Returns: A reference to this object.

◆ SetExtent() [1/2]

CullingKit& HPS::CullingKit::SetExtent	(	bool	in_state,
		unsigned int	in_pixels
	)

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]

CullingKit& HPS::CullingKit::SetExtent ( unsigned int in_pixels )

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

CullingKit& HPS::CullingKit::SetFrustum ( bool in_state )

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/4]

CullingKit& HPS::CullingKit::SetVector	(	bool	in_state,
		HPS::Vector const &	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_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/4]

CullingKit& HPS::CullingKit::SetVector	(	HPS::Vector const &	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_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/4]

CullingKit& HPS::CullingKit::SetVector	(	bool	in_state,
		HPS::Vector const &	in_vector = `Vector(0.0f, 0.0f, 1.0f)`
	)

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/4]

CullingKit& HPS::CullingKit::SetVector ( HPS::Vector const & 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_vector The reference vector to compare the view vector to.

Returns: A reference to this object.

◆ SetVectorTolerance()

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.

Parameters

in_tolerance_degrees The upper limit, in degrees, between the reference vector and the view vector.

Returns: A reference to this object.

◆ Show()

void HPS::CullingKit::Show ( CullingKit & out_kit ) const

Copies all settings from this CullingKit into the given CullingKit.

Parameters

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

◆ ShowBackFace()

bool HPS::CullingKit::ShowBackFace ( bool & out_state ) const

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

bool HPS::CullingKit::ShowDeferralExtent	(	bool &	out_state,
		unsigned int &	out_pixels
	)		const

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.

◆ ShowExtent()

bool HPS::CullingKit::ShowExtent	(	bool &	out_state,
		unsigned int &	out_pixels
	)		const

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

bool HPS::CullingKit::ShowFrustum ( bool & out_state ) const

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	(	bool &	out_state,
		HPS::Vector &	out_vector
	)		const

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 ( float & out_tolerance_degrees ) const

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.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetBackFace()

CullingKit& HPS::CullingKit::UnsetBackFace ( )

Removes the back face culling setting.

Returns: A reference to this object.

◆ UnsetDeferralExtent()

CullingKit& HPS::CullingKit::UnsetDeferralExtent ( )

Removes the extent culling setting.

Returns: A reference to this object.

◆ UnsetEverything()

CullingKit& HPS::CullingKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetExtent()

CullingKit& HPS::CullingKit::UnsetExtent ( )

Removes the extent culling setting.

Returns: A reference to this object.

◆ UnsetFrustum()

CullingKit& HPS::CullingKit::UnsetFrustum ( )

Removes the frustum culling setting.

Returns: A reference to this object.

◆ UnsetVector()

CullingKit& HPS::CullingKit::UnsetVector ( )

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

Returns: A reference to this object.

◆ UnsetVectorTolerance()

CullingKit& HPS::CullingKit::UnsetVectorTolerance ( )

Removes the vector culling tolerance setting only.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::CullingKit::staticType = HPS::Type::CullingKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CullingKit() [1/3]

◆ CullingKit() [2/3]

◆ CullingKit() [3/3]

◆ ~CullingKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetBackFace()

◆ SetDeferralExtent() [1/2]

◆ SetDeferralExtent() [2/2]

◆ SetExtent() [1/2]

◆ SetExtent() [2/2]

◆ SetFrustum()

◆ SetVector() [1/4]

◆ SetVector() [2/4]

◆ SetVector() [3/4]

◆ SetVector() [4/4]

◆ SetVectorTolerance()

◆ Show()

◆ ShowBackFace()

◆ ShowDeferralExtent()

◆ ShowExtent()

◆ ShowFrustum()

◆ ShowVector()

◆ ShowVectorTolerance()

◆ Type()

◆ UnsetBackFace()

◆ UnsetDeferralExtent()

◆ UnsetEverything()

◆ UnsetExtent()

◆ UnsetFrustum()

◆ UnsetVector()

◆ UnsetVectorTolerance()

Member Data Documentation

◆ staticType