HPS.VisualEffectsControl Class Reference
Inheritance diagram for HPS.VisualEffectsControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.VisualEffectsControl SetAmbientOcclusionEnabled (bool in_state)
 
HPS.VisualEffectsControl SetAntiAliasing (bool in_state)
 
HPS.VisualEffectsControl SetBloomEnabled (bool in_state)
 
HPS.VisualEffectsControl SetDepthOfFieldEnabled (bool in_state)
 
HPS.VisualEffectsControl SetEyeDomeLightingBackColor (bool in_state, HPS.RGBColor in_color)
 
HPS.VisualEffectsControl SetEyeDomeLightingBackColor (bool in_state)
 
HPS.VisualEffectsControl SetEyeDomeLightingBackColor (HPS.RGBColor in_color)
 
HPS.VisualEffectsControl SetEyeDomeLightingEnabled (bool in_state)
 
HPS.VisualEffectsControl SetPostProcessEffectsEnabled (bool in_state)
 
HPS.VisualEffectsControl SetShadowMaps (bool in_state, uint in_samples, uint in_resolution, bool in_view_dependent, bool in_jitter)
 
HPS.VisualEffectsControl SetShadowMaps (bool in_state, uint in_samples, uint in_resolution, bool in_view_dependent)
 
HPS.VisualEffectsControl SetShadowMaps (bool in_state, uint in_samples, uint in_resolution)
 
HPS.VisualEffectsControl SetShadowMaps (bool in_state, uint in_samples)
 
HPS.VisualEffectsControl SetShadowMaps (bool in_state)
 
HPS.VisualEffectsControl SetShadowMaps (uint in_samples, uint in_resolution, bool in_view_dependent, bool in_jitter)
 
HPS.VisualEffectsControl SetSilhouetteEdgesEnabled (bool in_state)
 
HPS.VisualEffectsControl SetSimpleReflection (bool in_state, float in_opacity, uint in_blurring, bool in_fading, float in_attenuation_near_distance, float in_attenuation_far_distance)
 
HPS.VisualEffectsControl SetSimpleReflection (bool in_state, float in_opacity, uint in_blurring, bool in_fading, float in_attenuation_near_distance)
 
HPS.VisualEffectsControl SetSimpleReflection (bool in_state, float in_opacity, uint in_blurring, bool in_fading)
 
HPS.VisualEffectsControl SetSimpleReflection (bool in_state, float in_opacity, uint in_blurring)
 
HPS.VisualEffectsControl SetSimpleReflection (bool in_state, float in_opacity)
 
HPS.VisualEffectsControl SetSimpleReflection (bool in_state)
 
HPS.VisualEffectsControl SetSimpleReflection (float in_opacity, uint in_blurring, bool in_fading, float in_attenuation_near_distance, float in_attenuation_far_distance)
 
HPS.VisualEffectsControl SetSimpleReflectionPlane (HPS.Plane in_projected_onto)
 
HPS.VisualEffectsControl SetSimpleReflectionPlane ()
 
HPS.VisualEffectsControl SetSimpleReflectionVisibility (HPS.VisibilityKit in_reflected_types)
 
HPS.VisualEffectsControl SetSimpleShadow (bool in_state, uint in_resolution, uint in_blurring, bool in_ignore_transparency)
 
HPS.VisualEffectsControl SetSimpleShadow (bool in_state, uint in_resolution, uint in_blurring)
 
HPS.VisualEffectsControl SetSimpleShadow (bool in_state, uint in_resolution)
 
HPS.VisualEffectsControl SetSimpleShadow (bool in_state)
 
HPS.VisualEffectsControl SetSimpleShadow (uint in_resolution, uint in_blurring, bool in_ignore_transparency)
 
HPS.VisualEffectsControl SetSimpleShadowColor (HPS.RGBAColor in_color)
 
HPS.VisualEffectsControl SetSimpleShadowColor ()
 
HPS.VisualEffectsControl SetSimpleShadowLightDirection (HPS.Vector in_direction)
 
HPS.VisualEffectsControl SetSimpleShadowLightDirection ()
 
HPS.VisualEffectsControl SetSimpleShadowPlane (HPS.Plane in_projected_onto)
 
HPS.VisualEffectsControl SetSimpleShadowPlane ()
 
HPS.VisualEffectsControl SetTextAntiAliasing (bool in_state)
 
bool ShowAmbientOcclusionEnabled (out bool out_state)
 
bool ShowAntiAliasing (out bool out_state)
 
bool ShowBloomEnabled (out bool out_state)
 
bool ShowDepthOfFieldEnabled (out bool out_state)
 
bool ShowEyeDomeLightingBackColor (out bool out_state, out HPS.RGBColor out_color)
 
bool ShowEyeDomeLightingEnabled (out bool out_state)
 
bool ShowPostProcessEffectsEnabled (out bool out_state)
 
bool ShowShadowMaps (out bool out_state, out uint out_samples, out uint out_resolution, out bool out_view_dependent, out bool out_jitter)
 
bool ShowSilhouetteEdgesEnabled (out bool out_state)
 
bool ShowSimpleReflection (out bool out_state, out float out_opacity, out uint out_blurring, out bool out_fading, out float out_attenuation_near_distance, out float out_attenuation_far_distance)
 
bool ShowSimpleReflectionPlane (out HPS.Plane out_projected_onto)
 
bool ShowSimpleReflectionVisibility (out HPS.VisibilityKit out_reflected_types)
 
bool ShowSimpleShadow (out bool out_state, out uint out_resolution, out uint out_blurring, out bool out_ignore_transparency)
 
bool ShowSimpleShadowColor (out HPS.RGBAColor out_color)
 
bool ShowSimpleShadowLightDirection (out HPS.Vector out_direction)
 
bool ShowSimpleShadowPlane (out HPS.Plane out_projected_onto)
 
bool ShowTextAntiAliasing (out bool out_state)
 
override HPS.Type Type ()
 
HPS.VisualEffectsControl UnsetAmbientOcclusionEnabled ()
 
HPS.VisualEffectsControl UnsetAntiAliasing ()
 
HPS.VisualEffectsControl UnsetBloomEnabled ()
 
HPS.VisualEffectsControl UnsetDepthOfFieldEnabled ()
 
HPS.VisualEffectsControl UnsetEverything ()
 
HPS.VisualEffectsControl UnsetEyeDomeLightingBackColor ()
 
HPS.VisualEffectsControl UnsetEyeDomeLightingEnabled ()
 
HPS.VisualEffectsControl UnsetPostProcessEffectsEnabled ()
 
HPS.VisualEffectsControl UnsetShadowMaps ()
 
HPS.VisualEffectsControl UnsetSilhouetteEdgesEnabled ()
 
HPS.VisualEffectsControl UnsetSimpleReflection ()
 
HPS.VisualEffectsControl UnsetSimpleReflectionPlane ()
 
HPS.VisualEffectsControl UnsetSimpleReflectionVisibility ()
 
HPS.VisualEffectsControl UnsetSimpleShadow ()
 
HPS.VisualEffectsControl UnsetSimpleShadowColor ()
 
HPS.VisualEffectsControl UnsetSimpleShadowLightDirection ()
 
HPS.VisualEffectsControl UnsetSimpleShadowPlane ()
 
HPS.VisualEffectsControl UnsetTextAntiAliasing ()
 
 VisualEffectsControl (HPS.SegmentKey in_seg)
 
 VisualEffectsControl (HPS.VisualEffectsControl in_that)
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

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

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

HPS.VisualEffectsControl.VisualEffectsControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ VisualEffectsControl() [2/2]

HPS.VisualEffectsControl.VisualEffectsControl ( HPS.VisualEffectsControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.VisualEffectsControl.ObjectType ( )
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.

◆ SetAmbientOcclusionEnabled()

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetAmbientOcclusionEnabled ( bool  in_state)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetAntiAliasing ( bool  in_state)
inline

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

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

◆ SetBloomEnabled()

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetBloomEnabled ( bool  in_state)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetDepthOfFieldEnabled ( bool  in_state)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetEyeDomeLightingBackColor ( bool  in_state,
HPS.RGBColor  in_color 
)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetEyeDomeLightingBackColor ( bool  in_state)
inline

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.
Returns
A reference to this object.

◆ SetEyeDomeLightingBackColor() [3/3]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetEyeDomeLightingBackColor ( HPS.RGBColor  in_color)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetEyeDomeLightingEnabled ( bool  in_state)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetPostProcessEffectsEnabled ( bool  in_state)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetShadowMaps ( bool  in_state,
uint  in_samples,
uint  in_resolution,
bool  in_view_dependent,
bool  in_jitter 
)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetShadowMaps ( bool  in_state,
uint  in_samples,
uint  in_resolution,
bool  in_view_dependent 
)
inline

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.
Returns
A reference to this object.

◆ SetShadowMaps() [3/6]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetShadowMaps ( bool  in_state,
uint  in_samples,
uint  in_resolution 
)
inline

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.
Returns
A reference to this object.

◆ SetShadowMaps() [4/6]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetShadowMaps ( bool  in_state,
uint  in_samples 
)
inline

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.
Returns
A reference to this object.

◆ SetShadowMaps() [5/6]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetShadowMaps ( bool  in_state)
inline

Manipulates the state of shadow maps in the scene.

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

◆ SetShadowMaps() [6/6]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetShadowMaps ( uint  in_samples,
uint  in_resolution,
bool  in_view_dependent,
bool  in_jitter 
)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSilhouetteEdgesEnabled ( bool  in_state)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflection ( bool  in_state,
float  in_opacity,
uint  in_blurring,
bool  in_fading,
float  in_attenuation_near_distance,
float  in_attenuation_far_distance 
)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflection ( bool  in_state,
float  in_opacity,
uint  in_blurring,
bool  in_fading,
float  in_attenuation_near_distance 
)
inline

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.
Returns
A reference to this object.

◆ SetSimpleReflection() [3/7]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflection ( bool  in_state,
float  in_opacity,
uint  in_blurring,
bool  in_fading 
)
inline

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.
Returns
A reference to this object.

◆ SetSimpleReflection() [4/7]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflection ( bool  in_state,
float  in_opacity,
uint  in_blurring 
)
inline

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].
Returns
A reference to this object.

◆ SetSimpleReflection() [5/7]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflection ( bool  in_state,
float  in_opacity 
)
inline

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.
Returns
A reference to this object.

◆ SetSimpleReflection() [6/7]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflection ( bool  in_state)
inline

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

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

◆ SetSimpleReflection() [7/7]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflection ( float  in_opacity,
uint  in_blurring,
bool  in_fading,
float  in_attenuation_near_distance,
float  in_attenuation_far_distance 
)
inline

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() [1/2]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflectionPlane ( HPS.Plane  in_projected_onto)
inline

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.

◆ SetSimpleReflectionPlane() [2/2]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflectionPlane ( )
inline

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

Returns
A reference to this object.

◆ SetSimpleReflectionVisibility()

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleReflectionVisibility ( HPS.VisibilityKit  in_reflected_types)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadow ( bool  in_state,
uint  in_resolution,
uint  in_blurring,
bool  in_ignore_transparency 
)
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadow ( bool  in_state,
uint  in_resolution,
uint  in_blurring 
)
inline

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].
Returns
A reference to this object.

◆ SetSimpleShadow() [3/5]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadow ( bool  in_state,
uint  in_resolution 
)
inline

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].
Returns
A reference to this object.

◆ SetSimpleShadow() [4/5]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadow ( bool  in_state)
inline

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

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

◆ SetSimpleShadow() [5/5]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadow ( uint  in_resolution,
uint  in_blurring,
bool  in_ignore_transparency 
)
inline

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() [1/2]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadowColor ( HPS.RGBAColor  in_color)
inline

Sets the color that simple shadows will be rendered in.

Parameters
in_colorThe color of simple shadows.
Returns
A reference to this object.

◆ SetSimpleShadowColor() [2/2]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadowColor ( )
inline

Sets the color that simple shadows will be rendered in.

Returns
A reference to this object.

◆ SetSimpleShadowLightDirection() [1/2]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadowLightDirection ( HPS.Vector  in_direction)
inline

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.

◆ SetSimpleShadowLightDirection() [2/2]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadowLightDirection ( )
inline

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

Returns
A reference to this object.

◆ SetSimpleShadowPlane() [1/2]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadowPlane ( HPS.Plane  in_projected_onto)
inline

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.

◆ SetSimpleShadowPlane() [2/2]

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetSimpleShadowPlane ( )
inline

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

Returns
A reference to this object.

◆ SetTextAntiAliasing()

HPS.VisualEffectsControl HPS.VisualEffectsControl.SetTextAntiAliasing ( bool  in_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

Shows the anti-aliasing setting.

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

◆ ShowBloomEnabled()

bool HPS.VisualEffectsControl.ShowBloomEnabled ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state,
out HPS.RGBColor  out_color 
)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state,
out uint  out_samples,
out uint  out_resolution,
out bool  out_view_dependent,
out bool  out_jitter 
)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state,
out float  out_opacity,
out uint  out_blurring,
out bool  out_fading,
out float  out_attenuation_near_distance,
out float  out_attenuation_far_distance 
)
inline

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 ( out HPS.Plane  out_projected_onto)
inline

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 ( out HPS.VisibilityKit  out_reflected_types)
inline

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 ( out bool  out_state,
out uint  out_resolution,
out uint  out_blurring,
out bool  out_ignore_transparency 
)
inline

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 ( out HPS.RGBAColor  out_color)
inline

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 ( out HPS.Vector  out_direction)
inline

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 ( out HPS.Plane  out_projected_onto)
inline

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 ( out bool  out_state)
inline

Shows the text anti-aliasing setting.

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

◆ Type()

override HPS.Type HPS.VisualEffectsControl.Type ( )
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()

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetAmbientOcclusionEnabled ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetAntiAliasing ( )
inline

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

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

◆ UnsetBloomEnabled()

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetBloomEnabled ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetDepthOfFieldEnabled ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetEverything ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetEyeDomeLightingBackColor ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetEyeDomeLightingEnabled ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetPostProcessEffectsEnabled ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetShadowMaps ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetSilhouetteEdgesEnabled ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetSimpleReflection ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetSimpleReflectionPlane ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetSimpleReflectionVisibility ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetSimpleShadow ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetSimpleShadowColor ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetSimpleShadowLightDirection ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetSimpleShadowPlane ( )
inline

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

HPS.VisualEffectsControl HPS.VisualEffectsControl.UnsetTextAntiAliasing ( )
inline

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:
  • internals/hps_core/source/cs/HPS.VisualEffectsControl.cs