VisualEffectsKit

class HPS.VisualEffectsKit : public HPS.Kit

The HPS.VisualEffectsKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.VisualEffectsKit.GetDefault() will return a kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return

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

bool Equals (HPS.VisualEffectsKit in_kit)

Check if the source VisualEffectsKit is equivalent to this object.

Param in_kit

The source VisualEffectsKit to compare to this object.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.VisualEffectsKit in_kit)

Copies the source VisualEffectsKit into this object.

Param in_kit

The source object to copy.

HPS.VisualEffectsKit SetAmbientOcclusionEnabled (bool in_state)

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

Param in_state

Whether ambient occlusion should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetAntiAliasing (bool in_state)

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.

Param in_state

Whether anti-aliasing(text and screen) should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetBloomEnabled (bool in_state)

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

Param in_state

Whether bloom should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetDepthOfFieldEnabled (bool in_state)

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

Param in_state

Whether depth of field should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetEyeDomeLightingBackColor (bool in_state)

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.

Param in_state

Whether a back color should be used for eye dome lighting.

Return

A reference to this object.

HPS.VisualEffectsKit SetEyeDomeLightingBackColor (bool in_state, HPS.RGBColor in_color)

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.

Param in_state

Whether a back color should be used for eye dome lighting.

Param in_color

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

Return

A reference to this object.

HPS.VisualEffectsKit SetEyeDomeLightingBackColor (HPS.RGBColor 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.

Param in_color

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

Return

A reference to this object.

HPS.VisualEffectsKit SetEyeDomeLightingEnabled (bool in_state)

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

Param in_state

Whether eye dome lighting should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetPostProcessEffectsEnabled (bool in_state)

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

Param in_state

Whether post-processing effects should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetShadowMaps (bool in_state)

Manipulates the state of shadow maps in the scene.

Param in_state

Whether shadow maps should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetShadowMaps (bool in_state, uint in_samples)

Manipulates the state of shadow maps in the scene.

Param in_state

Whether shadow maps should be used.

Param in_samples

The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. *

Return

A reference to this object.

HPS.VisualEffectsKit SetShadowMaps (bool in_state, uint in_samples, uint in_resolution)

Manipulates the state of shadow maps in the scene.

Param in_state

Whether shadow maps should be used.

Param in_samples

The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. *

Param in_resolution

The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. *

Return

A reference to this object.

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

Manipulates the state of shadow maps in the scene.

Param in_state

Whether shadow maps should be used.

Param in_samples

The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. *

Param in_resolution

The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. *

Param in_view_dependent

When enabled, the view frustum is taken into account when generating shadow maps. This results in significantly better visual quality, but at the cost of not being able to reuse shadow maps from previous frames, even if the lighting is constant with respect to the scene. *

Return

A reference to this object.

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

Manipulates the state of shadow maps in the scene.

Param in_state

Whether shadow maps should be used.

Param in_samples

The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. *

Param in_resolution

The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. *

Param in_view_dependent

When enabled, the view frustum is taken into account when generating shadow maps. This results in significantly better visual quality, but at the cost of not being able to reuse shadow maps from previous frames, even if the lighting is constant with respect to the scene. *

Param in_jitter

Turning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map. *

Return

A reference to this object.

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

Manipulates the state of shadow maps in the scene. The state is implicitly on.

Param in_samples

The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene. *

Param in_resolution

The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. *

Param in_view_dependent

When enabled, the view frustum is taken into account when generating shadow maps. This results in significantly better visual quality, but at the cost of not being able to reuse shadow maps from previous frames, even if the lighting is constant with respect to the scene. *

Param in_jitter

Turning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map. *

Return

A reference to this object.

HPS.VisualEffectsKit SetSilhouetteEdgesEnabled (bool in_state)

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

Param in_state

Whether silhouette edges should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleReflection (bool in_state)

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

Param in_state

Whether simple shadows should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleReflection (bool in_state, float in_opacity)

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

Param in_state

Whether simple shadows should be used.

Param in_opacity

An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.

Return

A reference to this object.

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

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

Param in_state

Whether simple shadows should be used.

Param in_opacity

An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.

Param in_blurring

The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].

Return

A reference to this object.

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

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

Param in_state

Whether simple shadows should be used.

Param in_opacity

An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.

Param in_blurring

The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].

Param in_fading

Whether the reflection plane should fade as it moves away from the camera.

Return

A reference to this object.

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

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

Param in_state

Whether simple shadows should be used.

Param in_opacity

An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.

Param in_blurring

The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].

Param in_fading

Whether the reflection plane should fade as it moves away from the camera.

Param in_attenuation_near_distance

The orthogonal distances (in world space) from the reflection plane that the model begins to fade. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleReflection (bool in_state, float in_opacity, uint 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.

Param in_state

Whether simple shadows should be used.

Param in_opacity

An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.

Param in_blurring

The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].

Param in_fading

Whether the reflection plane should fade as it moves away from the camera.

Param in_attenuation_near_distance

The orthogonal distances (in world space) from the reflection plane that the model begins to fade. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.

Param in_attenuation_far_distance

The orthogonal distances (in world space) from the reflection plane that the model is completely faded. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleReflection (float in_opacity, uint 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.

Param in_opacity

An alpha value that sets the transparency level of the reflection plane. Valid range is [0,1] with a value of zero making the plane completely transparent.

Param in_blurring

The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].

Param in_fading

Whether the reflection plane should fade as it moves away from the camera.

Param in_attenuation_near_distance

The orthogonal distances (in world space) from the reflection plane that the model begins to fade. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.

Param in_attenuation_far_distance

The orthogonal distances (in world space) from the reflection plane that the model is completely faded. Attenuation begins at in_attenuation_near_distance and increases linearly such that the model is not visible in the reflection beyond in_attenuation_far_distance.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleReflectionPlane ()

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

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleReflectionPlane (HPS.Plane in_projected_onto)

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

Param in_projected_onto

The plane that simple reflections should be projected onto.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleReflectionVisibility (HPS.VisibilityKit in_reflected_types)

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

Param in_reflected_types

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

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadow (bool in_state)

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

Param in_state

Whether simple shadows should be used.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadow (bool in_state, uint in_resolution)

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

Param in_state

Whether simple shadows should be used.

Param in_resolution

The width and height of the simple shadow. Valid range is [32, 1024].

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadow (bool in_state, uint in_resolution, uint in_blurring)

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

Param in_state

Whether simple shadows should be used.

Param in_resolution

The width and height of the simple shadow. Valid range is [32, 1024].

Param in_blurring

The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].

Return

A reference to this object.

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

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

Param in_state

Whether simple shadows should be used.

Param in_resolution

The width and height of the simple shadow. Valid range is [32, 1024].

Param in_blurring

The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].

Param in_ignore_transparency

Whether any segment-level transparency setting should be ignored when rendering the simple shadow.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadow (uint in_resolution, uint in_blurring, bool in_ignore_transparency)

Manipulates the state of simple shadows, projected onto a plane. The state is implicitly on.

Param in_resolution

The width and height of the simple shadow. Valid range is [32, 1024].

Param in_blurring

The level of blurring (softening) that is applied to the shadow. Valid range is [1,31].

Param in_ignore_transparency

Whether any segment-level transparency setting should be ignored when rendering the simple shadow.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadowColor ()

Sets the color that simple shadows will be rendered in.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadowColor (HPS.RGBAColor in_color)

Sets the color that simple shadows will be rendered in.

Param in_color

The color of simple shadows.

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadowLightDirection ()

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

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadowLightDirection (HPS.Vector in_direction)

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

Param in_direction

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

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadowPlane ()

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

Return

A reference to this object.

HPS.VisualEffectsKit SetSimpleShadowPlane (HPS.Plane in_projected_onto)

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

Param in_projected_onto

The plane that simple shadows should be projected onto.

Return

A reference to this object.

HPS.VisualEffectsKit SetTextAntiAliasing (bool in_state)

Manipulates the state of anti-aliasing.

Param in_state

Whether anti-aliasing should be used.

Return

A reference to this object.

void Show (out HPS.VisualEffectsKit out_kit)

Copies this object into the given VisualEffectsKit.

Param out_kit

The VisualEffectsKit to populate with the contents of this object.

bool ShowAmbientOcclusionEnabled (out bool out_state)

Shows the ambient occlusion setting.

Param out_state

Whether ambient occlusion is enabled.

Return

true if the setting is valid, false otherwise.

bool ShowAntiAliasing (out bool out_state)

Shows the anti-aliasing setting.

Deprecated:

This function exists for compatibility and ShowTextAntiAliasing(bool & out_state) should be preferred in general usage.

Param out_state

Whether anti-aliasing(text and screen) should be used.

Return

true if the setting(text and screen) is valid, false otherwise.

bool ShowBloomEnabled (out bool out_state)

Shows the bloom setting.

Param out_state

Whether bloom is enabled.

Return

true if the setting is valid, false otherwise.

bool ShowDepthOfFieldEnabled (out bool out_state)

Shows the depth of field setting.

Param out_state

Whether depth of field is enabled.

Return

true if the setting is valid, false otherwise.

bool ShowEyeDomeLightingBackColor (out bool out_state, out HPS.RGBColor out_color)

Shows the eye dome lighting back color setting.

Param out_state

Whether a back color should be used for eye dome lighting.

Param out_color

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

Return

true if the setting is valid, false otherwise.

bool ShowEyeDomeLightingEnabled (out bool out_state)

Shows the eye dome lighting setting.

Param out_state

Whether eye dome lighting is enabled.

Return

true if the setting is valid, false otherwise.

bool ShowPostProcessEffectsEnabled (out bool out_state)

Shows the post-processing effects setting.

Param out_state

Whether post-processing effects are enabled.

Return

true if the setting is valid, false otherwise.

bool ShowShadowMaps (out bool out_state, out uint out_samples, out uint out_resolution, out bool out_view_dependent, out bool out_jitter)

Shows the shadow maps setting.

Param out_state

Whether shadow maps should be used.

Param out_samples

The number of locations in the shadow map used to determine the percentage value of light received by a pixel in the rendered scene.

Param out_resolution

The width and height of the shadow map.

Param out_view_dependent

When enabled, the view frustum is taken into account when generating shadow maps.

Param out_jitter

Whether stochastic sampling of shadow maps should be use to reduce aliasing in the shadow map.

Return

true if the setting is valid, false otherwise.

bool ShowSilhouetteEdgesEnabled (out bool out_state)

Shows the silhouette edges setting.

Param out_state

Whether silhouette edges are enabled.

Return

true if the setting is valid, false otherwise.

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)

Shows the simple reflection setting.

Param out_state

Whether simple shadows should be used.

Param out_opacity

An alpha value that sets the transparency level of the reflection plane.

Param out_blurring

The level of blurring (softening) that is applied to the shadow.

Param out_fading

Whether the reflection plane should fade as it moves away from the camera.

Param out_attenuation_near_distance

The orthogonal distances (in world space) from the reflection plane that the model begins to fade.

Param out_attenuation_far_distance

The orthogonal distances (in world space) from the reflection plane that the model is completely faded.

Return

true if the setting is valid, false otherwise.

bool ShowSimpleReflectionPlane (out HPS.Plane out_projected_onto)

Shows the simple reflection plane setting.

Param out_projected_onto

The plane that simple reflections should be projected onto.

Return

true if the setting is valid, false otherwise.

bool ShowSimpleReflectionVisibility (out HPS.VisibilityKit out_reflected_types)

Shows the simple shadow visibility setting.

Param out_reflected_types

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

Return

true if the setting is valid, false otherwise.

bool ShowSimpleShadow (out bool out_state, out uint out_resolution, out uint out_blurring, out bool out_ignore_transparency)

Shows the simple shadow setting.

Param out_state

Whether simple shadows should be used.

Param out_resolution

The width and height of the simple shadow.

Param out_blurring

The level of blurring (softening) that is applied to the shadow.

Param out_ignore_transparency

Whether any segment-level transparency setting should be ignored when rendering the simple shadow.

Return

true if the setting is valid, false otherwise.

bool ShowSimpleShadowColor (out HPS.RGBAColor out_color)

Shows the simple shadow color setting.

Param out_color

The color of simple shadows.

Return

true if the setting is valid, false otherwise.

bool ShowSimpleShadowLightDirection (out HPS.Vector out_direction)

Shows the simple shadow light direction setting.

Param out_direction

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

Return

true if the setting is valid, false otherwise.

bool ShowSimpleShadowPlane (out HPS.Plane out_projected_onto)

Shows the simple shadow plane setting.

Param out_projected_onto

The plane that simple shadows should be projected onto.

Return

true if the setting is valid, false otherwise.

bool ShowTextAntiAliasing (out bool out_state)

Shows the text anti-aliasing setting.

Param out_state

Whether text anti-aliasing should be used.

Return

true if the setting is valid, false otherwise.

HPS.VisualEffectsKit UnsetAmbientOcclusionEnabled ()

Removes any ambient occlusion setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetAntiAliasing ()

Removes any anti-alias setting(text and screen).

Deprecated:

This function exists for compatibility and UnsetTextAntiAliasing() should be preferred in general usage.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetBloomEnabled ()

Removes any bloom setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetDepthOfFieldEnabled ()

Removes any depth of field setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetEverything ()

Removes all settings from this object.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetEyeDomeLightingBackColor ()

Removes any eye dome lighting back color setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetEyeDomeLightingEnabled ()

Removes any eye dome lighting setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetPostProcessEffectsEnabled ()

Removes any post-processing effects setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetShadowMaps ()

Removes any shadow maps setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetSilhouetteEdgesEnabled ()

Removes any silhouette edges setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetSimpleReflection ()

Removes any simple reflection setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetSimpleReflectionPlane ()

Removes any simple reflection plane setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetSimpleReflectionVisibility ()

Removes any simple reflection visibility setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetSimpleShadow ()

Removes any simple shadow setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetSimpleShadowColor ()

Removes any simple shadow color setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetSimpleShadowLightDirection ()

Removes any simple shadow light direction setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetSimpleShadowPlane ()

Removes any simple shadow plane setting.

Return

A reference to this object.

HPS.VisualEffectsKit UnsetTextAntiAliasing ()

Removes any text anti-alias setting.

Return

A reference to this object.

VisualEffectsKit ()

Initializes an empty kit.

VisualEffectsKit (HPS.VisualEffectsKit in_kit)

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

Param in_kit

The source object to copy.

Public Static Functions

HPS.VisualEffectsKit GetDefault ()

Creates a VisualEffectsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return

A VisualEffectsKit with the default settings.

bool operator!= (HPS.VisualEffectsKit a, HPS.VisualEffectsKit b)

bool operator== (HPS.VisualEffectsKit a, HPS.VisualEffectsKit b)