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

#include <hps.h>

Inheritance diagram for HPS::VisualEffectsKit:

Collaboration diagram for HPS::VisualEffectsKit:

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

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

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

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

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

HPS::Type	ObjectType () const

void	Set (VisualEffectsKit const &in_kit)
	Copies the source VisualEffectsKit into this object. More...

void	Show (VisualEffectsKit &out_kit) const
	Copies this object into the given VisualEffectsKit. More...

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

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

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

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

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

VisualEffectsKit &	SetPostProcessEffectsEnabled (bool in_state)
	Allows all post-processing effects to be enabled or disabled en masse on a per segment basis. More...

VisualEffectsKit &	SetAmbientOcclusionEnabled (bool in_state)
	Allows ambient occlusion to be enabled or disabled on a per segment basis. More...

VisualEffectsKit &	SetBloomEnabled (bool in_state)
	Allows bloom to be enabled or disabled on a per segment basis. More...

VisualEffectsKit &	SetDepthOfFieldEnabled (bool in_state)
	Allows depth of field to be enabled or disabled on a per segment basis. More...

VisualEffectsKit &	SetSilhouetteEdgesEnabled (bool in_state)
	Allows silhouette edges to be enabled or disabled on a per segment basis. More...

VisualEffectsKit &	SetEyeDomeLightingEnabled (bool in_state)
	Allows eye dome lighting to be enabled or disabled on a per segment basis. More...

VisualEffectsKit &	SetEyeDomeLightingBackColor (bool in_state, RGBColor const &in_color=RGBColor::Black())
	Sets the color to use for the back of a point in a point cloud when rendered via eye dome lighting. More...

VisualEffectsKit &	SetEyeDomeLightingBackColor (RGBColor const &in_color)
	Sets the color to use for the back of a point in a point cloud when rendered via eye dome lighting. More...

VisualEffectsKit &	SetAntiAliasing (bool in_state)
	Manipulates the state of anti-aliasing. More...

VisualEffectsKit &	SetShadowMaps (bool in_state, unsigned int in_samples=4, unsigned int in_resolution=1024, bool in_view_dependent=true, bool in_jitter=true)
	Manipulates the state of shadow maps in the scene. More...

VisualEffectsKit &	SetShadowMaps (unsigned int in_samples, unsigned int in_resolution, bool in_view_dependent, bool in_jitter)
	Manipulates the state of shadow maps in the scene. More...

VisualEffectsKit &	SetSimpleShadow (bool in_state, unsigned int in_resolution=256, unsigned int in_blurring=1, bool in_ignore_transparency=false)
	Manipulates the state of simple shadows, projected onto a plane. More...

VisualEffectsKit &	SetSimpleShadow (unsigned int in_resolution, unsigned int in_blurring, bool in_ignore_transparency)
	Manipulates the state of simple shadows, projected onto a plane. More...

VisualEffectsKit &	SetSimpleShadowPlane (Plane const &in_projected_onto=Plane(0.0f, 1.0f, 0.0f, 1.0f))
	Manipulates the location and orientation of the plane that simple shadows are projected onto. More...

VisualEffectsKit &	SetSimpleShadowLightDirection (Vector const &in_direction=Vector(0.0f, 1.0f, 0.0f))
	Sets the direction that the light source for a simple shadow is coming from. More...

VisualEffectsKit &	SetSimpleShadowColor (RGBAColor const &in_color=RGBAColor(0.0f, 0.0f, 0.0f, 1.0f))
	Sets the color that simple shadows will be rendered in. More...

VisualEffectsKit &	SetSimpleReflection (bool in_state, float in_opacity=0.5f, unsigned int in_blurring=1, bool in_fading=false, float in_attenuation_near_distance=0.0f, float in_attenuation_far_distance=Float::Infinity)
	Manipulates the state of simple reflections, projected onto a plane. More...

VisualEffectsKit &	SetSimpleReflection (float in_opacity, unsigned int in_blurring, bool in_fading, float in_attenuation_near_distance, float in_attenuation_far_distance)
	Manipulates the state of simple reflections, projected onto a plane. More...

VisualEffectsKit &	SetSimpleReflectionPlane (Plane const &in_projected_onto=Plane(0.0f, 1.0f, 0.0f, 1.0f))
	Manipulates the location and orientation of the plane that simple reflections are projected onto. More...

VisualEffectsKit &	SetSimpleReflectionVisibility (VisibilityKit const &in_reflected_types)
	Defines the visibility settings for the model when rendered in the reflection plane. More...

VisualEffectsKit &	UnsetPostProcessEffectsEnabled ()
	Removes any post-processing effects setting. More...

VisualEffectsKit &	UnsetAmbientOcclusionEnabled ()
	Removes any ambient occlusion setting. More...

VisualEffectsKit &	UnsetSilhouetteEdgesEnabled ()
	Removes any silhouette edges setting. More...

VisualEffectsKit &	UnsetDepthOfFieldEnabled ()
	Removes any depth of field setting. More...

VisualEffectsKit &	UnsetBloomEnabled ()
	Removes any bloom setting. More...

VisualEffectsKit &	UnsetEyeDomeLightingEnabled ()
	Removes any eye dome lighting setting. More...

VisualEffectsKit &	UnsetEyeDomeLightingBackColor ()
	Removes any eye dome lighting back color setting. More...

VisualEffectsKit &	UnsetAntiAliasing ()
	Removes any anti-alias setting. More...

VisualEffectsKit &	UnsetShadowMaps ()
	Removes any shadow maps setting. More...

VisualEffectsKit &	UnsetSimpleShadow ()
	Removes any simple shadow setting. More...

VisualEffectsKit &	UnsetSimpleShadowPlane ()
	Removes any simple shadow plane setting. More...

VisualEffectsKit &	UnsetSimpleShadowLightDirection ()
	Removes any simple shadow light direction setting. More...

VisualEffectsKit &	UnsetSimpleShadowColor ()
	Removes any simple shadow color setting. More...

VisualEffectsKit &	UnsetSimpleReflection ()
	Removes any simple reflection setting. More...

VisualEffectsKit &	UnsetSimpleReflectionPlane ()
	Removes any simple reflection plane setting. More...

VisualEffectsKit &	UnsetSimpleReflectionVisibility ()
	Removes any simple reflection visibility setting. More...

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

bool	ShowPostProcessEffectsEnabled (bool &out_state) const
	Shows the post-processing effects setting. More...

bool	ShowAmbientOcclusionEnabled (bool &out_state) const
	Shows the ambient occlusion setting. More...

bool	ShowSilhouetteEdgesEnabled (bool &out_state) const
	Shows the silhouette edges setting. More...

bool	ShowDepthOfFieldEnabled (bool &out_state) const
	Shows the depth of field setting. More...

bool	ShowBloomEnabled (bool &out_state) const
	Shows the bloom setting. More...

bool	ShowEyeDomeLightingEnabled (bool &out_state) const
	Shows the eye dome lighting setting. More...

bool	ShowEyeDomeLightingBackColor (bool &out_state, RGBColor &out_color) const
	Shows the eye dome lighting back color setting. More...

bool	ShowAntiAliasing (bool &out_state) const
	Shows the anti-aliasing setting. More...

bool	ShowShadowMaps (bool &out_state, unsigned int &out_samples, unsigned int &out_resolution, bool &out_view_dependent, bool &out_jitter) const
	Shows the shadow maps setting. More...

bool	ShowSimpleShadow (bool &out_state, unsigned int &out_resolution, unsigned int &out_blurring, bool &out_ignore_transparency) const
	Shows the simple shadow setting. More...

bool	ShowSimpleShadowPlane (Plane &out_projected_onto) const
	Shows the simple shadow plane setting. More...

bool	ShowSimpleShadowLightDirection (Vector &out_direction) const
	Shows the simple shadow light direction setting. More...

bool	ShowSimpleShadowColor (RGBAColor &out_color) const
	Shows the simple shadow color setting. More...

bool	ShowSimpleReflection (bool &out_state, float &out_opacity, unsigned int &out_blurring, bool &out_fading, float &out_attenuation_near_distance, float &out_attenuation_far_distance) const
	Shows the simple reflection setting. More...

bool	ShowSimpleReflectionPlane (Plane &out_projected_onto) const
	Shows the simple reflection plane setting. More...

bool	ShowSimpleReflectionVisibility (VisibilityKit &out_reflected_types) const
	Shows the simple shadow visibility setting. 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 VisualEffectsKit	GetDefault ()
	Creates a VisualEffectsKit 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::VisualEffectsKit

Detailed Description

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

Calling HPS::VisualEffectsKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ VisualEffectsKit() [1/3]

HPS::VisualEffectsKit::VisualEffectsKit ( )

Initializes an empty kit.

◆ VisualEffectsKit() [2/3]

HPS::VisualEffectsKit::VisualEffectsKit ( VisualEffectsKit const & in_kit )

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

Parameters

in_kit The source object to copy.

◆ VisualEffectsKit() [3/3]

HPS::VisualEffectsKit::VisualEffectsKit ( VisualEffectsKit && in_that )

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

Parameters

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

◆ ~VisualEffectsKit()

virtual HPS::VisualEffectsKit::~VisualEffectsKit ( )

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::VisualEffectsKit::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::VisualEffectsKit::Equals ( VisualEffectsKit const & in_kit ) const

Check if the source VisualEffectsKit is equivalent to this object.

Parameters

in_kit The source VisualEffectsKit 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 VisualEffectsKit HPS::VisualEffectsKit::GetDefault ( )

static

Creates a VisualEffectsKit 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 VisualEffectsKit 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::VisualEffectsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source VisualEffectsKit to compare to this object.

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

◆ operator=() [1/2]

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

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

Parameters

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

Returns: A reference to this VisualEffectsKit.

◆ operator=() [2/2]

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

Copies the source VisualEffectsKit into this object.

Parameters

in_kit The source VisualEffectsKit to copy.

Returns: A reference to this object.

◆ operator==()

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

Check if the source VisualEffectsKit is equivalent to this object.

Parameters

in_kit The source VisualEffectsKit 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::VisualEffectsKit::Set ( VisualEffectsKit const & in_kit )

Copies the source VisualEffectsKit into this object.

Parameters

in_kit The source object to copy.

◆ SetAmbientOcclusionEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::SetAmbientOcclusionEnabled ( bool in_state )

Allows ambient occlusion to be enabled or disabled on a per segment basis.

Parameters

in_state Whether ambient occlusion should be used.

Returns: A reference to this object.

◆ SetAntiAliasing()

VisualEffectsKit& HPS::VisualEffectsKit::SetAntiAliasing ( bool in_state )

Manipulates the state of anti-aliasing.

Parameters

in_state Whether anti-aliasing should be used.

Returns: A reference to this object.

◆ SetBloomEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::SetBloomEnabled ( bool in_state )

Allows bloom to be enabled or disabled on a per segment basis.

Parameters

in_state Whether bloom should be used.

Returns: A reference to this object.

◆ SetDepthOfFieldEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::SetDepthOfFieldEnabled ( bool in_state )

Allows depth of field to be enabled or disabled on a per segment basis.

Parameters

in_state Whether depth of field should be used.

Returns: A reference to this object.

◆ SetEyeDomeLightingBackColor() [1/2]

VisualEffectsKit& HPS::VisualEffectsKit::SetEyeDomeLightingBackColor	(	bool	in_state,
		RGBColor const &	in_color = `RGBColor::Black()`
	)

Sets the color to use for the back of a point in a point cloud when rendered via eye dome lighting.

Note: For this setting to have an effect, the points in a point cloud must have normals specified.

Parameters

in_state	Whether a back color should be used for eye dome lighting.
in_color	The color to use for the back of a point for eye dome lighting.

Returns: A reference to this object.

◆ SetEyeDomeLightingBackColor() [2/2]

VisualEffectsKit& HPS::VisualEffectsKit::SetEyeDomeLightingBackColor ( RGBColor const & in_color )

Sets the color to use for the back of a point in a point cloud when rendered via eye dome lighting.

The state is implicitly on.

Note: For this setting to have an effect, the points in a point cloud must have normals specified.

Parameters

in_color The color to use for the back of a point for eye dome lighting.

Returns: A reference to this object.

◆ SetEyeDomeLightingEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::SetEyeDomeLightingEnabled ( bool in_state )

Allows eye dome lighting to be enabled or disabled on a per segment basis.

Parameters

in_state Whether eye dome lighting should be used.

Returns: A reference to this object.

◆ SetPostProcessEffectsEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::SetPostProcessEffectsEnabled ( bool in_state )

Allows all post-processing effects to be enabled or disabled en masse on a per segment basis.

Parameters

in_state Whether post-processing effects should be used.

Returns: A reference to this object.

◆ SetShadowMaps() [1/2]

VisualEffectsKit& HPS::VisualEffectsKit::SetShadowMaps	(	bool	in_state,
		unsigned int	in_samples = `4`,
		unsigned int	in_resolution = `1024`,
		bool	in_view_dependent = `true`,
		bool	in_jitter = `true`
	)

Manipulates the state of shadow maps in the scene.

Parameters

in_state	Whether shadow maps should be used.
in_samples	The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene.
in_resolution	The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048.
in_view_dependent	When enabled, the view frustum is taken into account when generating shadow maps. This results in significantly better visual quality, but at the cost of not being able to reuse shadow maps from previous frames, even if the lighting is constant with respect to the scene.
in_jitter	Turning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map.

Returns: A reference to this object.

◆ SetShadowMaps() [2/2]

VisualEffectsKit& HPS::VisualEffectsKit::SetShadowMaps	(	unsigned int	in_samples,
		unsigned int	in_resolution,
		bool	in_view_dependent,
		bool	in_jitter
	)

Manipulates the state of shadow maps in the scene.

The state is implicitly on.

Parameters

in_samples	The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene.
in_resolution	The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048.
in_view_dependent	When enabled, the view frustum is taken into account when generating shadow maps. This results in significantly better visual quality, but at the cost of not being able to reuse shadow maps from previous frames, even if the lighting is constant with respect to the scene.
in_jitter	Turning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map.

Returns: A reference to this object.

◆ SetSilhouetteEdgesEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::SetSilhouetteEdgesEnabled ( bool in_state )

Allows silhouette edges to be enabled or disabled on a per segment basis.

Parameters

in_state Whether silhouette edges should be used.

Returns: A reference to this object.

◆ SetSimpleReflection() [1/2]

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleReflection	(	bool	in_state,
		float	in_opacity = `0.5f`,
		unsigned int	in_blurring = `1`,
		bool	in_fading = `false`,
		float	in_attenuation_near_distance = `0.0f`,
		float	in_attenuation_far_distance = `Float::Infinity`
	)

Manipulates the state of simple reflections, projected onto a plane.

Parameters

in_state	Whether simple shadows should be used.
in_opacity	An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.
in_blurring	The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
in_fading	Whether the reflection plane should fade as it moves away from the camera.
in_attenuation_near_distance	The orthogonal distances (in world space) from the reflection plane that the model begins to fade. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.
in_attenuation_far_distance	The orthogonal distances (in world space) from the reflection plane that the model is completely faded. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.

Returns: A reference to this object.

◆ SetSimpleReflection() [2/2]

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleReflection	(	float	in_opacity,
		unsigned int	in_blurring,
		bool	in_fading,
		float	in_attenuation_near_distance,
		float	in_attenuation_far_distance
	)

Manipulates the state of simple reflections, projected onto a plane.

The state is implicitly on.

Parameters

in_opacity	An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.
in_blurring	The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
in_fading	Whether the reflection plane should fade as it moves away from the camera.
in_attenuation_near_distance	The orthogonal distances (in world space) from the reflection plane that the model begins to fade. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.
in_attenuation_far_distance	The orthogonal distances (in world space) from the reflection plane that the model is completely faded. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.

Returns: A reference to this object.

◆ SetSimpleReflectionPlane()

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleReflectionPlane ( Plane const & in_projected_onto = Plane(0.0f, 1.0f, 0.0f, 1.0f) )

Manipulates the location and orientation of the plane that simple reflections are projected onto.

Parameters

in_projected_onto The plane that simple reflections should be projected onto.

Returns: A reference to this object.

◆ SetSimpleReflectionVisibility()

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleReflectionVisibility ( VisibilityKit const & in_reflected_types )

Defines the visibility settings for the model when rendered in the reflection plane.

Parameters

in_reflected_types A collection of visibility settings that will be applied to the reflected geometry.

Returns: A reference to this object.

◆ SetSimpleShadow() [1/2]

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleShadow	(	bool	in_state,
		unsigned int	in_resolution = `256`,
		unsigned int	in_blurring = `1`,
		bool	in_ignore_transparency = `false`
	)

Manipulates the state of simple shadows, projected onto a plane.

Parameters

in_state	Whether simple shadows should be used.
in_resolution	The width and height of the simple shadow. Valid range is [32, 1024].
in_blurring	The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
in_ignore_transparency	Whether any segment-level transparency setting should be ignored when rendering the simple shadow.

Returns: A reference to this object.

◆ SetSimpleShadow() [2/2]

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleShadow	(	unsigned int	in_resolution,
		unsigned int	in_blurring,
		bool	in_ignore_transparency
	)

Manipulates the state of simple shadows, projected onto a plane.

The state is implicitly on.

Parameters

in_resolution	The width and height of the simple shadow. Valid range is [32, 1024].
in_blurring	The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
in_ignore_transparency	Whether any segment-level transparency setting should be ignored when rendering the simple shadow.

Returns: A reference to this object.

◆ SetSimpleShadowColor()

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleShadowColor ( RGBAColor const & in_color = RGBAColor(0.0f, 0.0f, 0.0f, 1.0f) )

Sets the color that simple shadows will be rendered in.

Parameters

in_color The color of simple shadows.

Returns: A reference to this object.

◆ SetSimpleShadowLightDirection()

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleShadowLightDirection ( Vector const & in_direction = Vector(0.0f, 1.0f, 0.0f) )

Sets the direction that the light source for a simple shadow is coming from.

Parameters

in_direction The direction that the light source for a simple shadow is coming from.

Returns: A reference to this object.

◆ SetSimpleShadowPlane()

VisualEffectsKit& HPS::VisualEffectsKit::SetSimpleShadowPlane ( Plane const & in_projected_onto = Plane(0.0f, 1.0f, 0.0f, 1.0f) )

Manipulates the location and orientation of the plane that simple shadows are projected onto.

Parameters

in_projected_onto The plane that simple shadows should be projected onto.

Returns: A reference to this object.

◆ Show()

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

Copies this object into the given VisualEffectsKit.

Parameters

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

◆ ShowAmbientOcclusionEnabled()

bool HPS::VisualEffectsKit::ShowAmbientOcclusionEnabled ( bool & out_state ) const

Shows the ambient occlusion setting.

Parameters

out_state Whether ambient occlusion is enabled.

Returns: true if the setting is valid, false otherwise.

◆ ShowAntiAliasing()

bool HPS::VisualEffectsKit::ShowAntiAliasing ( bool & out_state ) const

Shows the anti-aliasing setting.

Parameters

out_state Whether anti-aliasing should be used.

Returns: true if the setting is valid, false otherwise.

◆ ShowBloomEnabled()

bool HPS::VisualEffectsKit::ShowBloomEnabled ( bool & out_state ) const

Shows the bloom setting.

Parameters

out_state Whether bloom is enabled.

Returns: true if the setting is valid, false otherwise.

◆ ShowDepthOfFieldEnabled()

bool HPS::VisualEffectsKit::ShowDepthOfFieldEnabled ( bool & out_state ) const

Shows the depth of field setting.

Parameters

out_state Whether depth of field is enabled.

Returns: true if the setting is valid, false otherwise.

◆ ShowEyeDomeLightingBackColor()

bool HPS::VisualEffectsKit::ShowEyeDomeLightingBackColor	(	bool &	out_state,
		RGBColor &	out_color
	)		const

Shows the eye dome lighting back color setting.

Parameters

out_state	Whether a back color should be used for eye dome lighting.
out_color	The color to use for the back of a point for eye dome lighting.

Returns: true if the setting is valid, false otherwise.

◆ ShowEyeDomeLightingEnabled()

bool HPS::VisualEffectsKit::ShowEyeDomeLightingEnabled ( bool & out_state ) const

Shows the eye dome lighting setting.

Parameters

out_state Whether eye dome lighting is enabled.

Returns: true if the setting is valid, false otherwise.

◆ ShowPostProcessEffectsEnabled()

bool HPS::VisualEffectsKit::ShowPostProcessEffectsEnabled ( bool & out_state ) const

Shows the post-processing effects setting.

Parameters

out_state Whether post-processing effects are enabled.

Returns: true if the setting is valid, false otherwise.

◆ ShowShadowMaps()

bool HPS::VisualEffectsKit::ShowShadowMaps	(	bool &	out_state,
		unsigned int &	out_samples,
		unsigned int &	out_resolution,
		bool &	out_view_dependent,
		bool &	out_jitter
	)		const

Shows the shadow maps setting.

Parameters

out_state	Whether shadow maps should be used.
out_samples	The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene.
out_resolution	The width and height of the shadow map.
out_view_dependent	When enabled, the view frustum is taken into account when generating shadow maps.
out_jitter	Whether stochastic sampling of shadow maps should be use to reduce aliasing in the shadow map.

Returns: true if the setting is valid, false otherwise.

◆ ShowSilhouetteEdgesEnabled()

bool HPS::VisualEffectsKit::ShowSilhouetteEdgesEnabled ( bool & out_state ) const

Shows the silhouette edges setting.

Parameters

out_state Whether silhouette edges are enabled.

Returns: true if the setting is valid, false otherwise.

◆ ShowSimpleReflection()

bool HPS::VisualEffectsKit::ShowSimpleReflection	(	bool &	out_state,
		float &	out_opacity,
		unsigned int &	out_blurring,
		bool &	out_fading,
		float &	out_attenuation_near_distance,
		float &	out_attenuation_far_distance
	)		const

Shows the simple reflection setting.

Parameters

out_state	Whether simple shadows should be used.
out_opacity	An alpha value that sets the transparency level of the reflection plane.
out_blurring	The level of blurring (softening) that is applied to the shadow.
out_fading	Whether the reflection plane should fade as it moves away from the camera.
out_attenuation_near_distance	The orthogonal distances (in world space) from the reflection plane that the model begins to fade.
out_attenuation_far_distance	The orthogonal distances (in world space) from the reflection plane that the model is completely faded.

Returns: true if the setting is valid, false otherwise.

◆ ShowSimpleReflectionPlane()

bool HPS::VisualEffectsKit::ShowSimpleReflectionPlane ( Plane & out_projected_onto ) const

Shows the simple reflection plane setting.

Parameters

out_projected_onto The plane that simple reflections should be projected onto.

Returns: true if the setting is valid, false otherwise.

◆ ShowSimpleReflectionVisibility()

bool HPS::VisualEffectsKit::ShowSimpleReflectionVisibility ( VisibilityKit & out_reflected_types ) const

Shows the simple shadow visibility setting.

Parameters

out_reflected_types A collection of visibility settings that will be applied to the reflected geometry.

Returns: true if the setting is valid, false otherwise.

◆ ShowSimpleShadow()

bool HPS::VisualEffectsKit::ShowSimpleShadow	(	bool &	out_state,
		unsigned int &	out_resolution,
		unsigned int &	out_blurring,
		bool &	out_ignore_transparency
	)		const

Shows the simple shadow setting.

Parameters

out_state	Whether simple shadows should be used.
out_resolution	The width and height of the simple shadow.
out_blurring	The level of blurring (softening) that is applied to the shadow.
out_ignore_transparency	Whether any segment-level transparency setting should be ignored when rendering the simple shadow.

Returns: true if the setting is valid, false otherwise.

◆ ShowSimpleShadowColor()

bool HPS::VisualEffectsKit::ShowSimpleShadowColor ( RGBAColor & out_color ) const

Shows the simple shadow color setting.

Parameters

out_color The color of simple shadows.

Returns: true if the setting is valid, false otherwise.

◆ ShowSimpleShadowLightDirection()

bool HPS::VisualEffectsKit::ShowSimpleShadowLightDirection ( Vector & out_direction ) const

Shows the simple shadow light direction setting.

Parameters

out_direction The direction that the light source for a simple shadow is coming from.

Returns: true if the setting is valid, false otherwise.

◆ ShowSimpleShadowPlane()

bool HPS::VisualEffectsKit::ShowSimpleShadowPlane ( Plane & out_projected_onto ) const

Shows the simple shadow plane setting.

Parameters

out_projected_onto The plane that simple shadows should be projected onto.

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.

◆ UnsetAmbientOcclusionEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetAmbientOcclusionEnabled ( )

Removes any ambient occlusion setting.

Returns: A reference to this object.

◆ UnsetAntiAliasing()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetAntiAliasing ( )

Removes any anti-alias setting.

Returns: A reference to this object.

◆ UnsetBloomEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetBloomEnabled ( )

Removes any bloom setting.

Returns: A reference to this object.

◆ UnsetDepthOfFieldEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetDepthOfFieldEnabled ( )

Removes any depth of field setting.

Returns: A reference to this object.

◆ UnsetEverything()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetEyeDomeLightingBackColor()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetEyeDomeLightingBackColor ( )

Removes any eye dome lighting back color setting.

Returns: A reference to this object.

◆ UnsetEyeDomeLightingEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetEyeDomeLightingEnabled ( )

Removes any eye dome lighting setting.

Returns: A reference to this object.

◆ UnsetPostProcessEffectsEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetPostProcessEffectsEnabled ( )

Removes any post-processing effects setting.

Returns: A reference to this object.

◆ UnsetShadowMaps()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetShadowMaps ( )

Removes any shadow maps setting.

Returns: A reference to this object.

◆ UnsetSilhouetteEdgesEnabled()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetSilhouetteEdgesEnabled ( )

Removes any silhouette edges setting.

Returns: A reference to this object.

◆ UnsetSimpleReflection()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetSimpleReflection ( )

Removes any simple reflection setting.

Returns: A reference to this object.

◆ UnsetSimpleReflectionPlane()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetSimpleReflectionPlane ( )

Removes any simple reflection plane setting.

Returns: A reference to this object.

◆ UnsetSimpleReflectionVisibility()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetSimpleReflectionVisibility ( )

Removes any simple reflection visibility setting.

Returns: A reference to this object.

◆ UnsetSimpleShadow()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetSimpleShadow ( )

Removes any simple shadow setting.

Returns: A reference to this object.

◆ UnsetSimpleShadowColor()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetSimpleShadowColor ( )

Removes any simple shadow color setting.

Returns: A reference to this object.

◆ UnsetSimpleShadowLightDirection()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetSimpleShadowLightDirection ( )

Removes any simple shadow light direction setting.

Returns: A reference to this object.

◆ UnsetSimpleShadowPlane()

VisualEffectsKit& HPS::VisualEffectsKit::UnsetSimpleShadowPlane ( )

Removes any simple shadow plane setting.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::VisualEffectsKit::staticType = HPS::Type::VisualEffectsKit

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

◆ VisualEffectsKit() [1/3]

◆ VisualEffectsKit() [2/3]

◆ VisualEffectsKit() [3/3]

◆ ~VisualEffectsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAmbientOcclusionEnabled()

◆ SetAntiAliasing()

◆ SetBloomEnabled()

◆ SetDepthOfFieldEnabled()

◆ SetEyeDomeLightingBackColor() [1/2]

◆ SetEyeDomeLightingBackColor() [2/2]

◆ SetEyeDomeLightingEnabled()

◆ SetPostProcessEffectsEnabled()

◆ SetShadowMaps() [1/2]

◆ SetShadowMaps() [2/2]

◆ SetSilhouetteEdgesEnabled()

◆ SetSimpleReflection() [1/2]

◆ SetSimpleReflection() [2/2]

◆ SetSimpleReflectionPlane()

◆ SetSimpleReflectionVisibility()

◆ SetSimpleShadow() [1/2]

◆ SetSimpleShadow() [2/2]

◆ SetSimpleShadowColor()

◆ SetSimpleShadowLightDirection()

◆ SetSimpleShadowPlane()

◆ Show()

◆ ShowAmbientOcclusionEnabled()

◆ ShowAntiAliasing()

◆ ShowBloomEnabled()

◆ ShowDepthOfFieldEnabled()

◆ ShowEyeDomeLightingBackColor()

◆ ShowEyeDomeLightingEnabled()

◆ ShowPostProcessEffectsEnabled()

◆ ShowShadowMaps()

◆ ShowSilhouetteEdgesEnabled()

◆ ShowSimpleReflection()

◆ ShowSimpleReflectionPlane()

◆ ShowSimpleReflectionVisibility()

◆ ShowSimpleShadow()

◆ ShowSimpleShadowColor()

◆ ShowSimpleShadowLightDirection()

◆ ShowSimpleShadowPlane()

◆ Type()

◆ UnsetAmbientOcclusionEnabled()

◆ UnsetAntiAliasing()

◆ UnsetBloomEnabled()

◆ UnsetDepthOfFieldEnabled()

◆ UnsetEverything()

◆ UnsetEyeDomeLightingBackColor()

◆ UnsetEyeDomeLightingEnabled()

◆ UnsetPostProcessEffectsEnabled()

◆ UnsetShadowMaps()

◆ UnsetSilhouetteEdgesEnabled()

◆ UnsetSimpleReflection()

◆ UnsetSimpleReflectionPlane()

◆ UnsetSimpleReflectionVisibility()

◆ UnsetSimpleShadow()

◆ UnsetSimpleShadowColor()

◆ UnsetSimpleShadowLightDirection()

◆ UnsetSimpleShadowPlane()

Member Data Documentation