REFERENCE MANUAL
The VisualEffectsKit class is a user space object, useful for carrying a group attribute settings. More...
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. More... | |
void | Set (HPS.VisualEffectsKit in_kit) |
Copies the source VisualEffectsKit into this object. More... | |
HPS.VisualEffectsKit | SetAntiAliasing (bool in_state) |
Manipulates the state of anti-aliasing. 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. 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. 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. 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 | ShowAntiAliasing (out bool out_state) |
Shows the anti-aliasing 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 | 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 | UnsetAntiAliasing () |
Removes any anti-alias setting. More... | |
HPS.VisualEffectsKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.VisualEffectsKit | UnsetPostProcessEffectsEnabled () |
Removes any post-processing effects setting. More... | |
HPS.VisualEffectsKit | UnsetShadowMaps () |
Removes any shadow maps 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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.VisualEffectsKit | GetDefault () |
Creates a VisualEffectsKit which contains the default settings. More... | |
static bool | operator!= (HPS.VisualEffectsKit a, HPS.VisualEffectsKit b) |
static bool | operator== (HPS.VisualEffectsKit a, HPS.VisualEffectsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The VisualEffectsKit class is a user space object, useful for carrying a group attribute settings.
Calling VisualEffectsKit::GetDefault() will return a kit with values found in this table.
HPS.VisualEffectsKit.VisualEffectsKit | ( | ) |
Initializes an empty kit.
HPS.VisualEffectsKit.VisualEffectsKit | ( | HPS.VisualEffectsKit | in_kit | ) |
The copy constructor creates a new VisualEffectsKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
bool HPS.VisualEffectsKit.Equals | ( | HPS.VisualEffectsKit | in_kit | ) |
Check if the source VisualEffectsKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_visual_effects_kit" kindref="compound">VisualEffectsKit</ref> to compare to this object. |
|
static |
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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.VisualEffectsKit.Set | ( | HPS.VisualEffectsKit | in_kit | ) |
Copies the source VisualEffectsKit into this object.
in_kit | The source object to copy. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetAntiAliasing | ( | bool | in_state | ) |
Manipulates the state of anti-aliasing.
in_state | Whether anti-aliasing should be used. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetPostProcessEffectsEnabled | ( | bool | in_state | ) |
Allows all post-processing effects to be enabled or disabled en masse on a per segment basis.
in_state | Whether post-processing effects should be used. |
HPS.VisualEffectsKit 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.
in_state | Whether shadow maps should be used. |
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. |
in_resolution | The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. |
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. |
in_jitter | Turning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map. |
HPS.VisualEffectsKit 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.
in_state | Whether shadow maps should be used. |
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. |
in_resolution | The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. |
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. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetShadowMaps | ( | bool | in_state, |
uint | in_samples, | ||
uint | in_resolution | ||
) |
Manipulates the state of shadow maps in the scene.
in_state | Whether shadow maps should be used. |
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. |
in_resolution | The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetShadowMaps | ( | bool | in_state, |
uint | in_samples | ||
) |
Manipulates the state of shadow maps in the scene.
in_state | Whether shadow maps should be used. |
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. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetShadowMaps | ( | bool | in_state | ) |
Manipulates the state of shadow maps in the scene.
in_state | Whether shadow maps should be used. |
HPS.VisualEffectsKit 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.
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. |
in_resolution | The width and height of the shadow map. This value will be clamped up/down to 512, 1024 or 2048. |
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. |
in_jitter | Turning this on causes stochastic sampling of shadow maps. This should reduce aliasing in the shadow map. |
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 | ||
) |
Manipulates the state of simple reflections, projected onto a plane.
in_state | Whether simple shadows should be used. |
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. |
in_blurring | The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. |
in_fading | Whether the reflection plane should fade as it moves away from the camera. |
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. |
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. |
HPS.VisualEffectsKit 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.
in_state | Whether simple shadows should be used. |
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. |
in_blurring | The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. |
in_fading | Whether the reflection plane should fade as it moves away from the camera. |
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. |
HPS.VisualEffectsKit 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.
in_state | Whether simple shadows should be used. |
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. |
in_blurring | The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. |
in_fading | Whether the reflection plane should fade as it moves away from the camera. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleReflection | ( | bool | in_state, |
float | in_opacity, | ||
uint | in_blurring | ||
) |
Manipulates the state of simple reflections, projected onto a plane.
in_state | Whether simple shadows should be used. |
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. |
in_blurring | The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleReflection | ( | bool | in_state, |
float | in_opacity | ||
) |
Manipulates the state of simple reflections, projected onto a plane.
in_state | Whether simple shadows should be used. |
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. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleReflection | ( | bool | in_state | ) |
Manipulates the state of simple reflections, projected onto a plane.
in_state | Whether simple shadows should be used. |
HPS.VisualEffectsKit 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.
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. |
in_blurring | The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. |
in_fading | Whether the reflection plane should fade as it moves away from the camera. |
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. |
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. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleReflectionPlane | ( | HPS.Plane | in_projected_onto | ) |
Manipulates the location and orientation of the plane that simple reflections are projected onto.
in_projected_onto | The plane that simple reflections should be projected onto. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleReflectionPlane | ( | ) |
Manipulates the location and orientation of the plane that simple reflections are projected onto.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleReflectionVisibility | ( | HPS.VisibilityKit | in_reflected_types | ) |
Defines the visibility settings for the model when rendered in the reflection plane.
in_reflected_types | A collection of visibility settings that will be applied to the reflected geometry. |
HPS.VisualEffectsKit 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.
in_state | Whether simple shadows should be used. |
in_resolution | The width and height of the simple shadow. Valid range is [32, 1024]. |
in_blurring | The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. |
in_ignore_transparency | Whether any segment-level transparency setting should be ignored when rendering the simple shadow. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadow | ( | bool | in_state, |
uint | in_resolution, | ||
uint | in_blurring | ||
) |
Manipulates the state of simple shadows, projected onto a plane.
in_state | Whether simple shadows should be used. |
in_resolution | The width and height of the simple shadow. Valid range is [32, 1024]. |
in_blurring | The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadow | ( | bool | in_state, |
uint | in_resolution | ||
) |
Manipulates the state of simple shadows, projected onto a plane.
in_state | Whether simple shadows should be used. |
in_resolution | The width and height of the simple shadow. Valid range is [32, 1024]. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadow | ( | bool | in_state | ) |
Manipulates the state of simple shadows, projected onto a plane.
in_state | Whether simple shadows should be used. |
HPS.VisualEffectsKit 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.
in_resolution | The width and height of the simple shadow. Valid range is [32, 1024]. |
in_blurring | The level of blurring (softening) that is applied to the shadow. Valid range is [1,31]. |
in_ignore_transparency | Whether any segment-level transparency setting should be ignored when rendering the simple shadow. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowColor | ( | HPS.RGBAColor | in_color | ) |
Sets the color that simple shadows will be rendered in.
in_color | The color of simple shadows. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowColor | ( | ) |
Sets the color that simple shadows will be rendered in.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowLightDirection | ( | HPS.Vector | in_direction | ) |
Sets the direction that the light source for a simple shadow is coming from.
in_direction | The direction that the light source for a simple shadow is coming from. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowLightDirection | ( | ) |
Sets the direction that the light source for a simple shadow is coming from.
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowPlane | ( | HPS.Plane | in_projected_onto | ) |
Manipulates the location and orientation of the plane that simple shadows are projected onto.
in_projected_onto | The plane that simple shadows should be projected onto. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.SetSimpleShadowPlane | ( | ) |
Manipulates the location and orientation of the plane that simple shadows are projected onto.
void HPS.VisualEffectsKit.Show | ( | out HPS.VisualEffectsKit | out_kit | ) |
Copies this object into the given VisualEffectsKit.
out_kit | The <ref refid="class_h_p_s_1_1_visual_effects_kit" kindref="compound">VisualEffectsKit</ref> to populate with the contents of this object. |
bool HPS.VisualEffectsKit.ShowAntiAliasing | ( | out bool | out_state | ) |
Shows the anti-aliasing setting.
out_state | Whether anti-aliasing should be used. |
bool HPS.VisualEffectsKit.ShowPostProcessEffectsEnabled | ( | out bool | out_state | ) |
Shows the post-processing effects setting.
out_state | Whether post-processing effects are enabled. |
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 | ||
) |
Shows the shadow maps setting.
out_state | Whether shadow maps should be used. |
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. |
out_resolution | The width and height of the shadow map. |
out_view_dependent | When enabled, the view frustum is taken into account when generating shadow maps. |
out_jitter | Whether stochastic sampling of shadow maps should be use to reduce aliasing in the shadow map. |
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 | ||
) |
Shows the simple reflection setting.
out_state | Whether simple shadows should be used. |
out_opacity | An alpha value that sets the transparency level of the reflection plane. |
out_blurring | The level of blurring (softening) that is applied to the shadow. |
out_fading | Whether the reflection plane should fade as it moves away from the camera. |
out_attenuation_near_distance | The orthogonal distances (in world space) from the reflection plane that the model begins to fade. |
out_attenuation_far_distance | The orthogonal distances (in world space) from the reflection plane that the model is completely faded. |
bool HPS.VisualEffectsKit.ShowSimpleReflectionPlane | ( | out HPS.Plane | out_projected_onto | ) |
Shows the simple reflection plane setting.
out_projected_onto | The plane that simple reflections should be projected onto. |
bool HPS.VisualEffectsKit.ShowSimpleReflectionVisibility | ( | out HPS.VisibilityKit | out_reflected_types | ) |
Shows the simple shadow visibility setting.
out_reflected_types | A collection of visibility settings that will be applied to the reflected geometry. |
bool HPS.VisualEffectsKit.ShowSimpleShadow | ( | out bool | out_state, |
out uint | out_resolution, | ||
out uint | out_blurring, | ||
out bool | out_ignore_transparency | ||
) |
Shows the simple shadow setting.
out_state | Whether simple shadows should be used. |
out_resolution | The width and height of the simple shadow. |
out_blurring | The level of blurring (softening) that is applied to the shadow. |
out_ignore_transparency | Whether any segment-level transparency setting should be ignored when rendering the simple shadow. |
bool HPS.VisualEffectsKit.ShowSimpleShadowColor | ( | out HPS.RGBAColor | out_color | ) |
Shows the simple shadow color setting.
out_color | The color of simple shadows. |
bool HPS.VisualEffectsKit.ShowSimpleShadowLightDirection | ( | out HPS.Vector | out_direction | ) |
Shows the simple shadow light direction setting.
out_direction | The direction that the light source for a simple shadow is coming from. |
bool HPS.VisualEffectsKit.ShowSimpleShadowPlane | ( | out HPS.Plane | out_projected_onto | ) |
Shows the simple shadow plane setting.
out_projected_onto | The plane that simple shadows should be projected onto. |
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetAntiAliasing | ( | ) |
Removes any anti-alias setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetPostProcessEffectsEnabled | ( | ) |
Removes any post-processing effects setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetShadowMaps | ( | ) |
Removes any shadow maps setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleReflection | ( | ) |
Removes any simple reflection setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleReflectionPlane | ( | ) |
Removes any simple reflection plane setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleReflectionVisibility | ( | ) |
Removes any simple reflection visibility setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleShadow | ( | ) |
Removes any simple shadow setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleShadowColor | ( | ) |
Removes any simple shadow color setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleShadowLightDirection | ( | ) |
Removes any simple shadow light direction setting.
HPS.VisualEffectsKit HPS.VisualEffectsKit.UnsetSimpleShadowPlane | ( | ) |
Removes any simple shadow plane setting.