HPS::VisualEffectsControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::VisualEffectsControl:
HPS::Control HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
VisualEffectsControloperator= (VisualEffectsControl &&in_that)
 
VisualEffectsControloperator= (VisualEffectsControl const &in_that)
 
VisualEffectsControlSetAmbientOcclusionEnabled (bool in_state)
 
VisualEffectsControlSetAntiAliasing (bool in_state)
 
VisualEffectsControlSetBloomEnabled (bool in_state)
 
VisualEffectsControlSetDepthOfFieldEnabled (bool in_state)
 
VisualEffectsControlSetEyeDomeLightingBackColor (bool in_state, RGBColor const &in_color=RGBColor::Black())
 
VisualEffectsControlSetEyeDomeLightingBackColor (RGBColor const &in_color)
 
VisualEffectsControlSetEyeDomeLightingEnabled (bool in_state)
 
VisualEffectsControlSetPostProcessEffectsEnabled (bool in_state)
 
VisualEffectsControlSetShadowMaps (bool in_state, unsigned int in_samples=4, unsigned int in_resolution=1024, bool in_view_dependent=true, bool in_jitter=true)
 
VisualEffectsControlSetShadowMaps (unsigned int in_samples, unsigned int in_resolution, bool in_view_dependent, bool in_jitter)
 
VisualEffectsControlSetSilhouetteEdgesEnabled (bool in_state)
 
VisualEffectsControlSetSimpleReflection (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)
 
VisualEffectsControlSetSimpleReflection (float in_opacity, unsigned int in_blurring, bool in_fading, float in_attenuation_near_distance, float in_attenuation_far_distance)
 
VisualEffectsControlSetSimpleReflectionPlane (Plane const &in_projected_onto=Plane(0.0f, 1.0f, 0.0f, 1.0f))
 
VisualEffectsControlSetSimpleReflectionVisibility (VisibilityKit const &in_reflected_types)
 
VisualEffectsControlSetSimpleShadow (bool in_state, unsigned int in_resolution=256, unsigned int in_blurring=1, bool in_ignore_transparency=false)
 
VisualEffectsControlSetSimpleShadow (unsigned int in_resolution, unsigned int in_blurring, bool in_ignore_transparency)
 
VisualEffectsControlSetSimpleShadowColor (RGBAColor const &in_color=RGBAColor(0.0f, 0.0f, 0.0f, 1.0f))
 
VisualEffectsControlSetSimpleShadowLightDirection (Vector const &in_direction=Vector(0.0f, 1.0f, 0.0f))
 
VisualEffectsControlSetSimpleShadowPlane (Plane const &in_projected_onto=Plane(0.0f, 1.0f, 0.0f, 1.0f))
 
VisualEffectsControlSetTextAntiAliasing (bool in_state)
 
bool ShowAmbientOcclusionEnabled (bool &out_state) const
 
bool ShowAntiAliasing (bool &out_state) const
 
bool ShowBloomEnabled (bool &out_state) const
 
bool ShowDepthOfFieldEnabled (bool &out_state) const
 
bool ShowEyeDomeLightingBackColor (bool &out_state, RGBColor &out_color) const
 
bool ShowEyeDomeLightingEnabled (bool &out_state) const
 
bool ShowPostProcessEffectsEnabled (bool &out_state) const
 
bool ShowShadowMaps (bool &out_state, unsigned int &out_samples, unsigned int &out_resolution, bool &out_view_dependent, bool &out_jitter) const
 
bool ShowSilhouetteEdgesEnabled (bool &out_state) const
 
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
 
bool ShowSimpleReflectionPlane (Plane &out_projected_onto) const
 
bool ShowSimpleReflectionVisibility (VisibilityKit &out_reflected_types) const
 
bool ShowSimpleShadow (bool &out_state, unsigned int &out_resolution, unsigned int &out_blurring, bool &out_ignore_transparency) const
 
bool ShowSimpleShadowColor (RGBAColor &out_color) const
 
bool ShowSimpleShadowLightDirection (Vector &out_direction) const
 
bool ShowSimpleShadowPlane (Plane &out_projected_onto) const
 
bool ShowTextAntiAliasing (bool &out_state) const
 
virtual HPS::Type Type () const
 
VisualEffectsControlUnsetAmbientOcclusionEnabled ()
 
VisualEffectsControlUnsetAntiAliasing ()
 
VisualEffectsControlUnsetBloomEnabled ()
 
VisualEffectsControlUnsetDepthOfFieldEnabled ()
 
VisualEffectsControlUnsetEverything ()
 
VisualEffectsControlUnsetEyeDomeLightingBackColor ()
 
VisualEffectsControlUnsetEyeDomeLightingEnabled ()
 
VisualEffectsControlUnsetPostProcessEffectsEnabled ()
 
VisualEffectsControlUnsetShadowMaps ()
 
VisualEffectsControlUnsetSilhouetteEdgesEnabled ()
 
VisualEffectsControlUnsetSimpleReflection ()
 
VisualEffectsControlUnsetSimpleReflectionPlane ()
 
VisualEffectsControlUnsetSimpleReflectionVisibility ()
 
VisualEffectsControlUnsetSimpleShadow ()
 
VisualEffectsControlUnsetSimpleShadowColor ()
 
VisualEffectsControlUnsetSimpleShadowLightDirection ()
 
VisualEffectsControlUnsetSimpleShadowPlane ()
 
VisualEffectsControlUnsetTextAntiAliasing ()
 
 VisualEffectsControl (SegmentKey &in_seg)
 
 VisualEffectsControl (VisualEffectsControl const &in_that)
 
 VisualEffectsControl (VisualEffectsControl &&in_that)
 
 ~VisualEffectsControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::VisualEffectsControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The HPS::VisualEffectsControl class is a smart pointer that is tied to a database object. This object enables you to set and unset various visual effects, such as shadows (including shadow color), reflection planes, and anti-aliasing.

Default values for the various fields of HPS::VisualEffectsControl can be found here.

Constructor & Destructor Documentation

◆ VisualEffectsControl() [1/3]

HPS::VisualEffectsControl::VisualEffectsControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ VisualEffectsControl() [2/3]

HPS::VisualEffectsControl::VisualEffectsControl ( VisualEffectsControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ VisualEffectsControl() [3/3]

HPS::VisualEffectsControl::VisualEffectsControl ( VisualEffectsControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a VisualEffectsControl to take the impl from.

◆ ~VisualEffectsControl()

HPS::VisualEffectsControl::~VisualEffectsControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::VisualEffectsControl::ObjectType ( ) const
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::Control.

◆ operator=() [1/2]

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

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

Parameters
in_thatAn rvalue reference to a VisualEffectsControl to take the impl from.
Returns
A reference to this VisualEffectsControl.

◆ operator=() [2/2]

VisualEffectsControl& HPS::VisualEffectsControl::operator= ( VisualEffectsControl const &  in_that)

Share the underlying smart-pointer of the VisualEffectsControl source.

Parameters
in_thatThe VisualEffectsControl source of the assignment.
Returns
A reference to this VisualEffectsControl.

◆ SetAmbientOcclusionEnabled()

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

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

Parameters
in_stateWhether ambient occlusion should be used.
Returns
A reference to this object.

◆ SetAntiAliasing()

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

Manipulates the state of anti-aliasing(text and screen).

Parameters
in_stateWhether anti-aliasing(text and screen) should be used.
Returns
A reference to this object.
Deprecated:
This function exists for compatibility and SetTextAntiAliasing(bool in_state) should be preferred in general usage.

◆ SetBloomEnabled()

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

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

Parameters
in_stateWhether bloom should be used.
Returns
A reference to this object.

◆ SetDepthOfFieldEnabled()

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

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

Parameters
in_stateWhether depth of field should be used.
Returns
A reference to this object.

◆ SetEyeDomeLightingBackColor() [1/2]

VisualEffectsControl& HPS::VisualEffectsControl::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_stateWhether a back color should be used for eye dome lighting.
in_colorThe color to use for the back of a point for eye dome lighting.
Returns
A reference to this object.

◆ SetEyeDomeLightingBackColor() [2/2]

VisualEffectsControl& HPS::VisualEffectsControl::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_colorThe color to use for the back of a point for eye dome lighting.
Returns
A reference to this object.

◆ SetEyeDomeLightingEnabled()

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

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

Parameters
in_stateWhether eye dome lighting should be used.
Returns
A reference to this object.

◆ SetPostProcessEffectsEnabled()

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

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

Parameters
in_stateWhether post-processing effects should be used.
Returns
A reference to this object.

◆ SetShadowMaps() [1/2]

VisualEffectsControl& HPS::VisualEffectsControl::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_stateWhether shadow maps should be used.
in_samplesThe number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene.
in_resolutionThe width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048.
in_view_dependentWhen 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_jitterTurning 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]

VisualEffectsControl& HPS::VisualEffectsControl::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_samplesThe number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene.
in_resolutionThe width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048.
in_view_dependentWhen 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_jitterTurning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map.
Returns
A reference to this object.

◆ SetSilhouetteEdgesEnabled()

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

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

Parameters
in_stateWhether silhouette edges should be used.
Returns
A reference to this object.

◆ SetSimpleReflection() [1/2]

VisualEffectsControl& HPS::VisualEffectsControl::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_stateWhether simple shadows should be used.
in_opacityAn 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_blurringThe level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
in_fadingWhether the reflection plane should fade as it moves away from the camera.
in_attenuation_near_distanceThe 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_distanceThe 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]

VisualEffectsControl& HPS::VisualEffectsControl::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_opacityAn 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_blurringThe level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
in_fadingWhether the reflection plane should fade as it moves away from the camera.
in_attenuation_near_distanceThe 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_distanceThe 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()

VisualEffectsControl& HPS::VisualEffectsControl::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_ontoThe plane that simple reflections should be projected onto.
Returns
A reference to this object.

◆ SetSimpleReflectionVisibility()

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

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

Parameters
in_reflected_typesA collection of visibility settings that will be applied to the reflected geometry.
Returns
A reference to this object.

◆ SetSimpleShadow() [1/2]

VisualEffectsControl& HPS::VisualEffectsControl::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_stateWhether simple shadows should be used.
in_resolutionThe width and height of the simple shadow. Valid range is [32, 1024].
in_blurringThe level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
in_ignore_transparencyWhether any segment-level transparency setting should be ignored when rendering the simple shadow.
Returns
A reference to this object.

◆ SetSimpleShadow() [2/2]

VisualEffectsControl& HPS::VisualEffectsControl::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_resolutionThe width and height of the simple shadow. Valid range is [32, 1024].
in_blurringThe level of blurring (softening) that is applied to the shadow. Valid range is [1,31].
in_ignore_transparencyWhether any segment-level transparency setting should be ignored when rendering the simple shadow.
Returns
A reference to this object.

◆ SetSimpleShadowColor()

VisualEffectsControl& HPS::VisualEffectsControl::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_colorThe color of simple shadows.
Returns
A reference to this object.

◆ SetSimpleShadowLightDirection()

VisualEffectsControl& HPS::VisualEffectsControl::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_directionThe direction that the light source for a simple shadow is coming from.
Returns
A reference to this object.

◆ SetSimpleShadowPlane()

VisualEffectsControl& HPS::VisualEffectsControl::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_ontoThe plane that simple shadows should be projected onto.
Returns
A reference to this object.

◆ SetTextAntiAliasing()

VisualEffectsControl& HPS::VisualEffectsControl::SetTextAntiAliasing ( bool  in_state)

Manipulates the state of text anti-aliasing.

Parameters
in_stateWhether text anti-aliasing should be used.
Returns
A reference to this object.

◆ ShowAmbientOcclusionEnabled()

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

Shows the ambient occlusion setting for the segment.

Parameters
out_stateWhether ambient occlusion is enabled.
Returns
true if the setting is valid, false otherwise.

◆ ShowAntiAliasing()

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

Shows the anti-aliasing setting.

Parameters
out_stateWhether anti-aliasing(text and screen) should be used.
Returns
true if the setting(text and screen) is valid, false otherwise.
Deprecated:
This function exists for compatibility and ShowTextAntiAliasing(bool & out_state) should be preferred in general usage.

◆ ShowBloomEnabled()

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

Shows the bloom setting for the segment.

Parameters
out_stateWhether bloom is enabled.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthOfFieldEnabled()

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

Shows the depth of field setting for the segment.

Parameters
out_stateWhether depth of field is enabled.
Returns
true if the setting is valid, false otherwise.

◆ ShowEyeDomeLightingBackColor()

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

Shows the eye dome lighting back color setting.

Parameters
out_stateWhether a back color should be used for eye dome lighting.
out_colorThe 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::VisualEffectsControl::ShowEyeDomeLightingEnabled ( bool &  out_state) const

Shows the eye dome lighting setting for the segment.

Parameters
out_stateWhether eye dome lighting is enabled.
Returns
true if the setting is valid, false otherwise.

◆ ShowPostProcessEffectsEnabled()

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

Shows the post-processing effects setting.

Parameters
out_stateWhether all post-processing effects are enabled for the segment.
Returns
true if the setting is valid, false otherwise.

◆ ShowShadowMaps()

bool HPS::VisualEffectsControl::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_stateWhether shadow maps should be used.
out_samplesThe number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene.
out_resolutionThe width and height of the shadow map.
out_view_dependentWhen enabled, the view frustum is taken into account when generating shadow maps.
out_jitterWhether 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::VisualEffectsControl::ShowSilhouetteEdgesEnabled ( bool &  out_state) const

Shows the silhouette edges setting for the segment.

Parameters
out_stateWhether silhouette edges are enabled.
Returns
true if the setting is valid, false otherwise.

◆ ShowSimpleReflection()

bool HPS::VisualEffectsControl::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_stateWhether simple shadows should be used.
out_opacityAn alpha value that sets the transparency level of the reflection plane.
out_blurringThe level of blurring (softening) that is applied to the shadow.
out_fadingWhether the reflection plane should fade as it moves away from the camera.
out_attenuation_near_distanceThe orthogonal distances (in world space) from the reflection plane that the model begins to fade.
out_attenuation_far_distanceThe 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::VisualEffectsControl::ShowSimpleReflectionPlane ( Plane out_projected_onto) const

Shows the simple reflection plane setting.

Parameters
out_projected_ontoThe plane that simple reflections should be projected onto.
Returns
true if the setting is valid, false otherwise.

◆ ShowSimpleReflectionVisibility()

bool HPS::VisualEffectsControl::ShowSimpleReflectionVisibility ( VisibilityKit out_reflected_types) const

Shows the simple shadow visibility setting.

Parameters
out_reflected_typesA collection of visibility settings that will be applied to the reflected geometry.
Returns
true if the setting is valid, false otherwise.

◆ ShowSimpleShadow()

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

Shows the simple shadow setting.

Parameters
out_stateWhether simple shadows should be used.
out_resolutionThe width and height of the simple shadow.
out_blurringThe level of blurring (softening) that is applied to the shadow.
out_ignore_transparencyWhether 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::VisualEffectsControl::ShowSimpleShadowColor ( RGBAColor out_color) const

Shows the simple shadow color setting.

Parameters
out_colorThe color of simple shadows.
Returns
true if the setting is valid, false otherwise.

◆ ShowSimpleShadowLightDirection()

bool HPS::VisualEffectsControl::ShowSimpleShadowLightDirection ( Vector out_direction) const

Shows the simple shadow light direction setting.

Parameters
out_directionThe direction that the light source for a simple shadow is coming from.
Returns
true if the setting is valid, false otherwise.

◆ ShowSimpleShadowPlane()

bool HPS::VisualEffectsControl::ShowSimpleShadowPlane ( Plane out_projected_onto) const

Shows the simple shadow plane setting.

Parameters
out_projected_ontoThe plane that simple shadows should be projected onto.
Returns
true if the setting is valid, false otherwise.

◆ ShowTextAntiAliasing()

bool HPS::VisualEffectsControl::ShowTextAntiAliasing ( bool &  out_state) const

Shows the text anti-aliasing setting.

Parameters
out_stateWhether anti-aliasing should be used.
Returns
true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::VisualEffectsControl::Type ( ) const
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetAmbientOcclusionEnabled()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetAmbientOcclusionEnabled ( )

Removes ambient occlusion setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetAntiAliasing()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetAntiAliasing ( )

Removes any anti-alias setting(text and screen). If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.
Deprecated:
This function exists for compatibility and UnsetTextAntiAliasing() should be preferred in general usage.

◆ UnsetBloomEnabled()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetBloomEnabled ( )

Removes any bloom setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetDepthOfFieldEnabled()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetDepthOfFieldEnabled ( )

Removes any depth of field setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetEverything()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetEverything ( )

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetEyeDomeLightingBackColor()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetEyeDomeLightingBackColor ( )

Removes any eye dome lighting back color setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetEyeDomeLightingEnabled()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetEyeDomeLightingEnabled ( )

Removes any eye dome lighting setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetPostProcessEffectsEnabled()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetPostProcessEffectsEnabled ( )

Removes any post-processing effects setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetShadowMaps()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetShadowMaps ( )

Removes any shadow maps setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSilhouetteEdgesEnabled()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetSilhouetteEdgesEnabled ( )

Removes any silhouette edges setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSimpleReflection()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetSimpleReflection ( )

Removes any simple reflection setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSimpleReflectionPlane()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetSimpleReflectionPlane ( )

Removes any simple reflection plane setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSimpleReflectionVisibility()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetSimpleReflectionVisibility ( )

Removes any simple reflection visibility setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSimpleShadow()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetSimpleShadow ( )

Removes any simple shadow setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSimpleShadowColor()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetSimpleShadowColor ( )

Removes any simple shadow color setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSimpleShadowLightDirection()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetSimpleShadowLightDirection ( )

Removes any simple shadow light direction setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSimpleShadowPlane()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetSimpleShadowPlane ( )

Removes any simple shadow plane setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

◆ UnsetTextAntiAliasing()

VisualEffectsControl& HPS::VisualEffectsControl::UnsetTextAntiAliasing ( )

Removes any text anti-alias setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Returns
A reference to this object.

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