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

Inheritance diagram for HPS.VisualEffectsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this object has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.VisualEffectsKit in_kit)
 Check if the source VisualEffectsKit is equivalent to this object. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.VisualEffectsKit in_kit)
 Copies the source VisualEffectsKit into this object. More...
 
HPS.VisualEffectsKit SetAmbientOcclusionEnabled (bool in_state)
 Allows ambient occlusion to be enabled or disabled on a per segment basis. More...
 
HPS.VisualEffectsKit SetAntiAliasing (bool in_state)
 Manipulates the state of anti-aliasing. More...
 
HPS.VisualEffectsKit SetBloomEnabled (bool in_state)
 Allows bloom to be enabled or disabled on a per segment basis. More...
 
HPS.VisualEffectsKit SetDepthOfFieldEnabled (bool in_state)
 Allows depth of field to be enabled or disabled on a per segment basis. More...
 
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. More...
 
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. More...
 
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. More...
 
HPS.VisualEffectsKit SetEyeDomeLightingEnabled (bool in_state)
 Allows eye dome lighting to be enabled or disabled on a per segment basis. More...
 
HPS.VisualEffectsKit SetPostProcessEffectsEnabled (bool in_state)
 Allows all post-processing effects to be enabled or disabled en masse on a per segment basis. More...
 
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. More...
 
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. More...
 
HPS.VisualEffectsKit SetShadowMaps (bool in_state, uint in_samples, uint in_resolution)
 Manipulates the state of shadow maps in the scene. More...
 
HPS.VisualEffectsKit SetShadowMaps (bool in_state, uint in_samples)
 Manipulates the state of shadow maps in the scene. More...
 
HPS.VisualEffectsKit SetShadowMaps (bool in_state)
 Manipulates the state of shadow maps in the scene. More...
 
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. More...
 
HPS.VisualEffectsKit SetSilhouetteEdgesEnabled (bool in_state)
 Allows silhouette edges to be enabled or disabled on a per segment basis. More...
 
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. More...
 
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. More...
 
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. More...
 
HPS.VisualEffectsKit SetSimpleReflection (bool in_state, float in_opacity, uint in_blurring)
 Manipulates the state of simple reflections, projected onto a plane. More...
 
HPS.VisualEffectsKit SetSimpleReflection (bool in_state, float in_opacity)
 Manipulates the state of simple reflections, projected onto a plane. More...
 
HPS.VisualEffectsKit SetSimpleReflection (bool in_state)
 Manipulates the state of simple reflections, projected onto a plane. More...
 
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. More...
 
HPS.VisualEffectsKit SetSimpleReflectionPlane (HPS.Plane in_projected_onto)
 Manipulates the location and orientation of the plane that simple reflections are projected onto. More...
 
HPS.VisualEffectsKit SetSimpleReflectionPlane ()
 Manipulates the location and orientation of the plane that simple reflections are projected onto. More...
 
HPS.VisualEffectsKit SetSimpleReflectionVisibility (HPS.VisibilityKit in_reflected_types)
 Defines the visibility settings for the model when rendered in the reflection plane. More...
 
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. More...
 
HPS.VisualEffectsKit SetSimpleShadow (bool in_state, uint in_resolution, uint in_blurring)
 Manipulates the state of simple shadows, projected onto a plane. More...
 
HPS.VisualEffectsKit SetSimpleShadow (bool in_state, uint in_resolution)
 Manipulates the state of simple shadows, projected onto a plane. More...
 
HPS.VisualEffectsKit SetSimpleShadow (bool in_state)
 Manipulates the state of simple shadows, projected onto a plane. More...
 
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. More...
 
HPS.VisualEffectsKit SetSimpleShadowColor (HPS.RGBAColor in_color)
 Sets the color that simple shadows will be rendered in. More...
 
HPS.VisualEffectsKit SetSimpleShadowColor ()
 Sets the color that simple shadows will be rendered in. More...
 
HPS.VisualEffectsKit SetSimpleShadowLightDirection (HPS.Vector in_direction)
 Sets the direction that the light source for a simple shadow is coming from. More...
 
HPS.VisualEffectsKit SetSimpleShadowLightDirection ()
 Sets the direction that the light source for a simple shadow is coming from. More...
 
HPS.VisualEffectsKit SetSimpleShadowPlane (HPS.Plane in_projected_onto)
 Manipulates the location and orientation of the plane that simple shadows are projected onto. More...
 
HPS.VisualEffectsKit SetSimpleShadowPlane ()
 Manipulates the location and orientation of the plane that simple shadows are projected onto. More...
 
void Show (out HPS.VisualEffectsKit out_kit)
 Copies this object into the given VisualEffectsKit. More...
 
bool ShowAmbientOcclusionEnabled (out bool out_state)
 Shows the ambient occlusion setting. More...
 
bool ShowAntiAliasing (out bool out_state)
 Shows the anti-aliasing setting. More...
 
bool ShowBloomEnabled (out bool out_state)
 Shows the bloom setting. More...
 
bool ShowDepthOfFieldEnabled (out bool out_state)
 Shows the depth of field setting. More...
 
bool ShowEyeDomeLightingBackColor (out bool out_state, out HPS.RGBColor out_color)
 Shows the eye dome lighting back color setting. More...
 
bool ShowEyeDomeLightingEnabled (out bool out_state)
 Shows the eye dome lighting setting. More...
 
bool ShowPostProcessEffectsEnabled (out bool out_state)
 Shows the post-processing effects setting. More...
 
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. More...
 
bool ShowSilhouetteEdgesEnabled (out bool out_state)
 Shows the silhouette edges setting. More...
 
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. More...
 
bool ShowSimpleReflectionPlane (out HPS.Plane out_projected_onto)
 Shows the simple reflection plane setting. More...
 
bool ShowSimpleReflectionVisibility (out HPS.VisibilityKit out_reflected_types)
 Shows the simple shadow visibility setting. More...
 
bool ShowSimpleShadow (out bool out_state, out uint out_resolution, out uint out_blurring, out bool out_ignore_transparency)
 Shows the simple shadow setting. More...
 
bool ShowSimpleShadowColor (out HPS.RGBAColor out_color)
 Shows the simple shadow color setting. More...
 
bool ShowSimpleShadowLightDirection (out HPS.Vector out_direction)
 Shows the simple shadow light direction setting. More...
 
bool ShowSimpleShadowPlane (out HPS.Plane out_projected_onto)
 Shows the simple shadow plane setting. More...
 
HPS.VisualEffectsKit UnsetAmbientOcclusionEnabled ()
 Removes any ambient occlusion setting. More...
 
HPS.VisualEffectsKit UnsetAntiAliasing ()
 Removes any anti-alias setting. More...
 
HPS.VisualEffectsKit UnsetBloomEnabled ()
 Removes any bloom setting. More...
 
HPS.VisualEffectsKit UnsetDepthOfFieldEnabled ()
 Removes any depth of field setting. More...
 
HPS.VisualEffectsKit UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.VisualEffectsKit UnsetEyeDomeLightingBackColor ()
 Removes any eye dome lighting back color setting. More...
 
HPS.VisualEffectsKit UnsetEyeDomeLightingEnabled ()
 Removes any eye dome lighting setting. More...
 
HPS.VisualEffectsKit UnsetPostProcessEffectsEnabled ()
 Removes any post-processing effects setting. More...
 
HPS.VisualEffectsKit UnsetShadowMaps ()
 Removes any shadow maps setting. More...
 
HPS.VisualEffectsKit UnsetSilhouetteEdgesEnabled ()
 Removes any silhouette edges setting. More...
 
HPS.VisualEffectsKit UnsetSimpleReflection ()
 Removes any simple reflection setting. More...
 
HPS.VisualEffectsKit UnsetSimpleReflectionPlane ()
 Removes any simple reflection plane setting. More...
 
HPS.VisualEffectsKit UnsetSimpleReflectionVisibility ()
 Removes any simple reflection visibility setting. More...
 
HPS.VisualEffectsKit UnsetSimpleShadow ()
 Removes any simple shadow setting. More...
 
HPS.VisualEffectsKit UnsetSimpleShadowColor ()
 Removes any simple shadow color setting. More...
 
HPS.VisualEffectsKit UnsetSimpleShadowLightDirection ()
 Removes any simple shadow light direction setting. More...
 
HPS.VisualEffectsKit UnsetSimpleShadowPlane ()
 Removes any simple shadow plane setting. More...
 
 VisualEffectsKit ()
 Initializes an empty kit. More...
 
 VisualEffectsKit (HPS.VisualEffectsKit in_kit)
 The copy constructor creates a new VisualEffectsKit object that contains the same settings as the source object. More...
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 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. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 

Static Public Member Functions

static 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. More...
 
static bool operator!= (HPS.VisualEffectsKit a, HPS.VisualEffectsKit b)
 
static bool operator== (HPS.VisualEffectsKit a, HPS.VisualEffectsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.VisualEffectsKit.VisualEffectsKit ( )
inline

Initializes an empty kit.

HPS.VisualEffectsKit.VisualEffectsKit ( HPS.VisualEffectsKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

override bool HPS.VisualEffectsKit.Empty ( )
inlinevirtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.VisualEffectsKit.Equals ( HPS.VisualEffectsKit  in_kit)
inline

Check if the source VisualEffectsKit is equivalent to this object.

Parameters
in_kitThe source VisualEffectsKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.VisualEffectsKit HPS.VisualEffectsKit.GetDefault ( )
inlinestatic

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

Returns
A VisualEffectsKit with the default settings.
override HPS.Type HPS.VisualEffectsKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Kit.

void HPS.VisualEffectsKit.Set ( HPS.VisualEffectsKit  in_kit)
inline

Copies the source VisualEffectsKit into this object.

Parameters
in_kitThe source object to copy.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetAntiAliasing ( bool  in_state)
inline

Manipulates the state of anti-aliasing.

Parameters
in_stateWhether anti-aliasing should be used.
Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetDepthOfFieldEnabled ( bool  in_state)
inline

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

Parameters
in_stateWhether depth of field should be used.
Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.

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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.

Parameters
in_stateWhether a back color should be used for eye dome lighting.
Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.

Parameters
in_colorThe color to use for the back of a point for eye dome lighting.
Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetEyeDomeLightingEnabled ( bool  in_state)
inline

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

Parameters
in_stateWhether eye dome lighting should be used.
Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit 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 
)
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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleReflectionPlane ( )
inline

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

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowColor ( )
inline

Sets the color that simple shadows will be rendered in.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowLightDirection ( )
inline

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

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowPlane ( )
inline

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

Returns
A reference to this object.
void HPS.VisualEffectsKit.Show ( out HPS.VisualEffectsKit  out_kit)
inline

Copies this object into the given VisualEffectsKit.

Parameters
out_kitThe VisualEffectsKit to populate with the contents of this object.
bool HPS.VisualEffectsKit.ShowAmbientOcclusionEnabled ( out bool  out_state)
inline

Shows the ambient occlusion setting.

Parameters
out_stateWhether ambient occlusion is enabled.
Returns
true if the setting is valid, false otherwise.
bool HPS.VisualEffectsKit.ShowAntiAliasing ( out bool  out_state)
inline

Shows the anti-aliasing setting.

Parameters
out_stateWhether anti-aliasing should be used.
Returns
true if the setting is valid, false otherwise.
bool HPS.VisualEffectsKit.ShowBloomEnabled ( out bool  out_state)
inline

Shows the bloom setting.

Parameters
out_stateWhether bloom is enabled.
Returns
true if the setting is valid, false otherwise.
bool HPS.VisualEffectsKit.ShowDepthOfFieldEnabled ( out bool  out_state)
inline

Shows the depth of field setting.

Parameters
out_stateWhether depth of field is enabled.
Returns
true if the setting is valid, false otherwise.
bool HPS.VisualEffectsKit.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.
bool HPS.VisualEffectsKit.ShowEyeDomeLightingEnabled ( out bool  out_state)
inline

Shows the eye dome lighting setting.

Parameters
out_stateWhether eye dome lighting is enabled.
Returns
true if the setting is valid, false otherwise.
bool HPS.VisualEffectsKit.ShowPostProcessEffectsEnabled ( out bool  out_state)
inline

Shows the post-processing effects setting.

Parameters
out_stateWhether post-processing effects are enabled.
Returns
true if the setting is valid, false otherwise.
bool HPS.VisualEffectsKit.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.
bool HPS.VisualEffectsKit.ShowSilhouetteEdgesEnabled ( out bool  out_state)
inline

Shows the silhouette edges setting.

Parameters
out_stateWhether silhouette edges are enabled.
Returns
true if the setting is valid, false otherwise.
bool HPS.VisualEffectsKit.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.
bool HPS.VisualEffectsKit.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.
bool HPS.VisualEffectsKit.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.
bool HPS.VisualEffectsKit.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.
bool HPS.VisualEffectsKit.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.
bool HPS.VisualEffectsKit.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.
bool HPS.VisualEffectsKit.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.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetAmbientOcclusionEnabled ( )
inline

Removes any ambient occlusion setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetAntiAliasing ( )
inline

Removes any anti-alias setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetBloomEnabled ( )
inline

Removes any bloom setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetDepthOfFieldEnabled ( )
inline

Removes any depth of field setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetEyeDomeLightingBackColor ( )
inline

Removes any eye dome lighting back color setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetEyeDomeLightingEnabled ( )
inline

Removes any eye dome lighting setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetPostProcessEffectsEnabled ( )
inline

Removes any post-processing effects setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetShadowMaps ( )
inline

Removes any shadow maps setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSilhouetteEdgesEnabled ( )
inline

Removes any silhouette edges setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleReflection ( )
inline

Removes any simple reflection setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleReflectionPlane ( )
inline

Removes any simple reflection plane setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleReflectionVisibility ( )
inline

Removes any simple reflection visibility setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleShadow ( )
inline

Removes any simple shadow setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleShadowColor ( )
inline

Removes any simple shadow color setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleShadowLightDirection ( )
inline

Removes any simple shadow light direction setting.

Returns
A reference to this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleShadowPlane ( )
inline

Removes any simple shadow plane setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.VisualEffectsKit.cs