Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
HPS::VisualEffectsControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::VisualEffectsControl:
Inheritance graph
[legend]
Collaboration diagram for HPS::VisualEffectsControl:
Collaboration graph
[legend]

Public Member Functions

 VisualEffectsControl (SegmentKey &in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 VisualEffectsControl (VisualEffectsControl const &in_that)
 Initializes a control tied to the same object as in_that. More...
 
 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. More...
 
VisualEffectsControl & operator= (VisualEffectsControl &&in_that)
 The move assignment operator transfers the underlying impl of the rvalue reference to this VisualEffectsControl thereby avoiding a copy. More...
 
 ~VisualEffectsControl ()
 Releases a reference to the database object this control is tied to. More...
 
virtual HPS::Type Type () const
 This function returns the true type of the underlying object. More...
 
HPS::Type ObjectType () const
 
VisualEffectsControl & operator= (VisualEffectsControl const &in_that)
 Share the underlying smart-pointer of the VisualEffectsControl source. More...
 
VisualEffectsControl & SetPostProcessEffectsEnabled (bool in_state)
 Allows all post-processing effects to be enabled or disabled en masse on a per segment basis. More...
 
VisualEffectsControl & SetAmbientOcclusionEnabled (bool in_state)
 Allows ambient occlusion to be enabled or disabled on a per segment basis. More...
 
VisualEffectsControl & SetSilhouetteEdgesEnabled (bool in_state)
 Allows silhouette edges to be enabled or disabled on a per segment basis. More...
 
VisualEffectsControl & SetDepthOfFieldEnabled (bool in_state)
 Allows depth of field to be enabled or disabled en masse on a per segment basis. More...
 
VisualEffectsControl & SetBloomEnabled (bool in_state)
 Allows bloom to be enabled or disabled on a per segment basis. More...
 
VisualEffectsControl & SetEyeDomeLightingEnabled (bool in_state)
 Allows eye dome lighting to be enabled or disabled en masse on a per segment basis. More...
 
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. More...
 
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. More...
 
VisualEffectsControl & SetAntiAliasing (bool in_state)
 Manipulates the state of anti-aliasing. More...
 
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. More...
 
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. More...
 
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. More...
 
VisualEffectsControl & SetSimpleShadow (unsigned int in_resolution, unsigned int in_blurring, bool in_ignore_transparency)
 Manipulates the state of simple shadows, projected onto a plane. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
VisualEffectsControl & SetSimpleReflectionVisibility (VisibilityKit const &in_reflected_types)
 Defines the visibility settings for the model when rendered in the reflection plane. More...
 
VisualEffectsControl & UnsetPostProcessEffectsEnabled ()
 Removes any post-processing effects setting. More...
 
VisualEffectsControl & UnsetAmbientOcclusionEnabled ()
 Removes ambient occlusion setting. More...
 
VisualEffectsControl & UnsetSilhouetteEdgesEnabled ()
 Removes any silhouette edges setting. More...
 
VisualEffectsControl & UnsetDepthOfFieldEnabled ()
 Removes any depth of field setting. More...
 
VisualEffectsControl & UnsetBloomEnabled ()
 Removes any bloom setting. More...
 
VisualEffectsControl & UnsetEyeDomeLightingEnabled ()
 Removes any eye dome lighting setting. More...
 
VisualEffectsControl & UnsetEyeDomeLightingBackColor ()
 Removes any eye dome lighting back color setting. More...
 
VisualEffectsControl & UnsetAntiAliasing ()
 Removes any anti-alias setting. More...
 
VisualEffectsControl & UnsetShadowMaps ()
 Removes any shadow maps setting. More...
 
VisualEffectsControl & UnsetSimpleShadow ()
 Removes any simple shadow setting. More...
 
VisualEffectsControl & UnsetSimpleShadowPlane ()
 Removes any simple shadow plane setting. More...
 
VisualEffectsControl & UnsetSimpleShadowLightDirection ()
 Removes any simple shadow light direction setting. More...
 
VisualEffectsControl & UnsetSimpleShadowColor ()
 Removes any simple shadow color setting. More...
 
VisualEffectsControl & UnsetSimpleReflection ()
 Removes any simple reflection setting. More...
 
VisualEffectsControl & UnsetSimpleReflectionPlane ()
 Removes any simple reflection plane setting. More...
 
VisualEffectsControl & UnsetSimpleReflectionVisibility ()
 Removes any simple reflection visibility setting. More...
 
VisualEffectsControl & 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 for the segment. More...
 
bool ShowSilhouetteEdgesEnabled (bool &out_state) const
 Shows the silhouette edges setting for the segment. More...
 
bool ShowDepthOfFieldEnabled (bool &out_state) const
 Shows the depth of field setting for the segment. More...
 
bool ShowBloomEnabled (bool &out_state) const
 Shows the bloom setting for the segment. More...
 
bool ShowEyeDomeLightingEnabled (bool &out_state) const
 Shows the eye dome lighting setting for the segment. 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 bool Empty () const
 Indicates whether this object has any values set on it. 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

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

Static Public Attributes

static const HPS::Type staticType = HPS::Type::VisualEffectsControl
 

Private Member Functions

 VisualEffectsControl ()
 Private default constructor to prevent instantiation without a segment. More...
 

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

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

Initializes a control tied to the segment in_seg.

◆ VisualEffectsControl() [2/4]

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

Initializes a control tied to the same object as in_that.

◆ VisualEffectsControl() [3/4]

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.

◆ VisualEffectsControl() [4/4]

HPS::VisualEffectsControl::VisualEffectsControl ( )
private

Private default constructor to prevent instantiation without a segment.

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

virtual bool HPS::Object::Empty ( ) const
inlinevirtualinherited

Indicates whether this object has any values set on it.

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

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

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

◆ 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_maskThe Type mask to check against this Object.
Returns
true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

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

Reimplemented from HPS::Control.

Here is the call graph for this function:

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

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

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

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

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

◆ 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 should be used.
Returns
true if the setting is valid, false otherwise.

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

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

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.

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.

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::VisualEffectsControl::staticType = HPS::Type::VisualEffectsControl
static
The documentation for this class was generated from the following file: