SCENE C++ API  2.0.27
Public Types | Public Member Functions | Static Public Member Functions | List of all members
LSView3dSettings Class Reference

Container collecting settings for the LSView3d class. More...

#include <lsview3dsettings.h>

+ Inheritance diagram for LSView3dSettings:

Public Types

enum  PointColoring {
  NoColoring, CoordinateColoringDistance, CoordinateColoringX,
  CoordinateColoringY, CoordinateColoringZ, CoordinateColoringXYZ,
  NormalVectors
}
 Various screen-space coloring effects. More...
 
enum  PostProcess { NoPostProcess, ClearView, GapFilling }
 Post-processing shader effects. More...
 
enum  Shading { NoShading, LightShading, StrongShading }
 Colors in the 3d view are manipulated so that areas around corners appear highlighted This achieves a clearer view of the geometry. More...
 
enum  PointSizeMode { Adaptive, Fixed }
 Manipulates the size of points shown in the 3d view. More...
 
enum  SuperSampling {
  NoSuperSampling, SuperSampling2x2, SuperSampling3x3,
  SuperSampling4x4
}
 Effect that achieves better image quality by drawing in a higher resolution than the one suggested by the the 3d view window and scaling back to the original resolution. More...
 
enum  ApplyShadingTo { Points, Meshes, Both }
 Restricts what types of objects Shading is applied to. More...
 
enum  ColorMap { Rainbow, ColdHot, Linear }
 Defines what type of colors will be used to display the PointColoring effect. More...
 

Public Member Functions

LSResult::Result setSuperSampling (const SuperSampling mode)
 Sets the mode of SuperSampling to be used in the view. More...
 
SuperSampling getSuperSampling () const
 Gets the mode of SuperSampling of the settings. More...
 
LSResult::Result setPointSizeMode (const PointSizeMode mode)
 Sets the mode for the size of points to be rendered in the view. More...
 
PointSizeMode getPointSizeMode () const
 Gets the mode for the size of points to be rendered in the view. More...
 
LSResult::Result setFixedPointSize (const unsigned int pixels)
 Sets the fixed point size. More...
 
unsigned int getFixedPointSize () const
 Gets the fixed point size. More...
 
LSResult::Result setAdaptivePointSize (const float meters)
 Sets the adaptive point size. More...
 
float getAdaptivePointSize () const
 Gets the adaptive point size. More...
 
LSResult::Result setPointColoring (const PointColoring mode)
 Sets the mode of PointColoring to be used in the view. More...
 
PointColoring getPointColoring () const
 Gets the PointColoring setting. More...
 
LSResult::Result setColoringRangeMin (const Eigen::Vector4d &min)
 Sets the lower bound of the ranges used by the PointColoring effects. More...
 
Eigen::Vector4d getColoringRangeMin () const
 Gets the lower bound of the ranges used by the PointColoring effects. More...
 
LSResult::Result setColoringRangeMax (const Eigen::Vector4d &max)
 Sets the upper bound of the ranges used by the PointColoring effects. More...
 
Eigen::Vector4d getColoringRangeMax () const
 Gets the upper bound of the ranges used by the coloring effects. More...
 
LSResult::Result setBlendColoringWithPointColors (const bool blendColoringWithPointColorsEnabled)
 Enables Coloring effects to be blended with point colors. More...
 
bool getBlendColoringWithPointColors () const
 Gets whether the setting to blend Coloring effects with point colors is enabled or not. More...
 
LSResult::Result setReferenceOrigin (const Eigen::Vector3d &origin)
 Sets the origin used in coordinate coloring. More...
 
Eigen::Vector3d getReferenceOrigin () const
 Sets the origin used in coordinate PointColoring. More...
 
LSResult::Result setReferencePose (const Eigen::Matrix4f &pose)
 Sets the orientation of the colorization. More...
 
Eigen::Matrix4f getReferencePose () const
 Gets the orientation of the colorization. More...
 
LSResult::Result setDiscreteColors (const bool discreteColorsEnabled)
 Enables/disables the discrete option for the coordinate colorization. More...
 
bool getDiscreteColors () const
 Gets whether the discrete option is enabled for the coordinate colorization. More...
 
LSResult::Result setNumOfDiscreteColors (const unsigned int numOfColors)
 Sets the number of intervals used for coordinate colorization. More...
 
unsigned int getNumOfDiscreteColors () const
 Gets the number of intervals used in PointColoring. More...
 
LSResult::Result setColorMap (const ColorMap mode)
 Sets the type of ColorMap that will be used in colorization. More...
 
ColorMap getColorMap () const
 Gets the type of ColorMap used in PointColoring effects. More...
 
LSResult::Result setCalculateDistanceFromCamera (const bool distanceFromCamera)
 Sets the setting for the origin for the mode PointColoring::CoordinateColoringDistance Setting this to true will use the camera as the origin from which the distance is calculated. More...
 
bool getCalculateDistanceFromCamera () const
 Gets the setting for the origin for the mode PointColoring::CoordinateColoringDistance If this value is true the mode PointColoring::CoordinateColoringDistance will use the camera as the origin from which the distance is calculated. More...
 
LSResult::Result setShading (const Shading mode)
 Sets the mode of Shading to be used in the view. More...
 
Shading getShading () const
 Gets the mode of Shading used in the view. More...
 
LSResult::Result setApplyShadingTo (const ApplyShadingTo mode)
 If any shading effect is enabled this will set whether this is applied to meshes, points, or both Default value is ApplyShadingTo::Both. More...
 
ApplyShadingTo getApplyShadingTo () const
 Gets what type of objects Shading effects are applied to Default value is ApplyShadingTo::Both. More...
 
LSResult::Result setShadingStrength (const uint8_t shadingStrength)
 Sets the shading strength setting used by shading effects Pass a value from 1 (small effect) to 5 (intense effect). More...
 
uint8_t getShadingStrength () const
 Gets the shading strength setting used by Shading effects. More...
 
LSResult::Result setPostProcess (const PostProcess mode)
 Enables a post-process effect for the view, e.g. More...
 
PostProcess getPostProcess () const
 Gets the PostProcess setting. More...
 
LSResult::Result setTransparencyFactor (const float factor)
 Sets the transparency factor for clear view rendering. More...
 
float getTransparencyFactor () const
 Gets the transparency factor for clear view rendering. More...
 
- Public Member Functions inherited from LSAttributeContainer
LSString getTypeName () const
 Gets the type name of this instance. More...
 
LSString getName () const
 Gets the name of the container. More...
 
LSResult::Result setName (LSString name)
 Sets the name of the container. More...
 
LSString getUuid () const
 Returns the unique id of the container. More...
 
LSString assignUuid ()
 Assigns a unique id to the container if the container does not not yet have a unique id. More...
 
unsigned int getNumAttributes () const
 Get the number of attributes in the container. More...
 
LSString getAttributeName (unsigned int index) const
 Get the name of an attribute in the container. More...
 
unsigned int getAttributeIndex (LSString name) const
 Get the index of an attribute in the container. More...
 
LSAttribute getAttribute (unsigned int index) const
 Get an attribute based on its index. More...
 
LSAttribute getAttribute (LSString name) const
 Get an attribute based on its name. More...
 
LSResult::Result setAttribute (unsigned int index, const LSAttribute &attribute)
 Set an attribute based on its index. More...
 
LSResult::Result setAttribute (LSString name, const LSAttribute &attribute)
 Set an attribute based on its name. More...
 
LSResult::Result addCustomAttribute (LSString name, const LSAttribute &attribute)
 Add a new custom attribute to the container. More...
 
bool removeCustomAttribute (LSString name)
 Remove a custom attribute from the container. More...
 
unsigned int getNumFields () const
 Returns the number of fields in the container. More...
 
ref_ptr< LSAttributeContainergetField (unsigned int index) const
 Returns the field at position n in the container. More...
 
ref_ptr< LSAttributeContainergetField (const LSString &name) const
 Returns the field with the given name. More...
 
LSResult::Result addField (const LSString &name, const LSString &typeName, ref_ptr< LSAttributeContainer > &fieldOut)
 Add a field to the container. More...
 
bool rmField (const LSString &name)
 Removes the field with a given name from the container. More...
 

Static Public Member Functions

static ref_ptr< LSView3dSettingscreate ()
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

Container collecting settings for the LSView3d class.

Version
SCENE API Version 2.0.25.

Member Enumeration Documentation

◆ PointColoring

enum PointColoring
strong

Various screen-space coloring effects.

Version
SCENE API Version 2.0.25.
Enumerator
NoColoring 

The effect is disabled.

CoordinateColoringDistance 

Points are colored with respect to a distance to some reference point.

CoordinateColoringX 

Points are colored with respect to their X coordinate.

CoordinateColoringY 

Points are colored with respect to their Y coordinate.

CoordinateColoringZ 

Points are colored with respect to their Z coordinate.

CoordinateColoringXYZ 

Points are colored with respect to all of their Cartesian coordinates.

NormalVectors 

the local normal vector of the area around each point is used to colorize each point

◆ PostProcess

enum PostProcess
strong

Post-processing shader effects.

Version
SCENE API Version 2.0.25.
Enumerator
NoPostProcess 

The effect is disabled.

ClearView 

The 3d view is shown with transparency, so that users can look through walls.

GapFilling 

Empty areas are filled with nearby colors.

◆ Shading

enum Shading
strong

Colors in the 3d view are manipulated so that areas around corners appear highlighted This achieves a clearer view of the geometry.

Version
SCENE API Version 2.0.25.
Enumerator
NoShading 

The effect is disabled.

LightShading 

The LightShading algorithm is used.

StrongShading 

The StrongShading algorithm is used.

◆ PointSizeMode

enum PointSizeMode
strong

Manipulates the size of points shown in the 3d view.

Version
SCENE API Version 2.0.25.
Enumerator
Adaptive 

The size of points changes depending on how far the point is from the camera.

Fixed 

The size of points stays the same for all points in the 3d view.

◆ SuperSampling

enum SuperSampling
strong

Effect that achieves better image quality by drawing in a higher resolution than the one suggested by the the 3d view window and scaling back to the original resolution.

Version
SCENE API Version 2.0.25.
Enumerator
NoSuperSampling 

The effect is disabled.

SuperSampling2x2 

An image twice the size of the 3d view in each dimension is used.

SuperSampling3x3 

An image three times the size of the 3d view in each dimension is used.

SuperSampling4x4 

An image four times the size of the 3d view in each dimension is used.

◆ ApplyShadingTo

enum ApplyShadingTo
strong

Restricts what types of objects Shading is applied to.

Version
SCENE API Version 2.0.25.
Enumerator
Points 

Shading is applied to points only.

Meshes 

Shading is applied to meshes only.

Both 

Shading is applied to both meshes and points.

◆ ColorMap

enum ColorMap
strong

Defines what type of colors will be used to display the PointColoring effect.

Version
SCENE API Version 2.0.25.
Enumerator
Rainbow 

A blue to red colormap is used.

ColdHot 

A blue to brown colormap is used.

Linear 

The intensity of the color is used to visualize the PointColoring effect.

Member Function Documentation

◆ create()

static ref_ptr<LSView3dSettings> create ( )
static
Returns
A new instance of the implementation class. The constructor can't be called directly. This function will return nullptr if creation was not successful. The new instance of this class will come with the default settings. The default value of each setting is stated in the corresponding function.
Version
SCENE API Version 2.0.25.

◆ setSuperSampling()

LSResult::Result setSuperSampling ( const SuperSampling  mode)

Sets the mode of SuperSampling to be used in the view.

To turn supersampling off pass SuperSampling::NoSuperSampling here. Default value is SuperSampling::NoSuperSampling

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getSuperSampling()

SuperSampling getSuperSampling ( ) const

Gets the mode of SuperSampling of the settings.

Default value is SuperSampling::NoSuperSampling

Returns
the SuperSampling mode stored in the settings.
Version
SCENE API Version 2.0.25.

◆ setPointSizeMode()

LSResult::Result setPointSizeMode ( const PointSizeMode  mode)

Sets the mode for the size of points to be rendered in the view.

Default value is PointSizeMode::Adaptive

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getPointSizeMode()

PointSizeMode getPointSizeMode ( ) const

Gets the mode for the size of points to be rendered in the view.

Default value is PointSizeMode::Adaptive

Returns
the point size mode
Version
SCENE API Version 2.0.25.

◆ setFixedPointSize()

LSResult::Result setFixedPointSize ( const unsigned int  pixels)

Sets the fixed point size.

The value represents the pixel size, and should be between 1px and 10px. If the value is not within this range, it will be clamped. Default value is 1.

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getFixedPointSize()

unsigned int getFixedPointSize ( ) const

Gets the fixed point size.

Default value is 1.

Returns
the fixed point size.
Version
SCENE API Version 2.0.25.

◆ setAdaptivePointSize()

LSResult::Result setAdaptivePointSize ( const float  meters)

Sets the adaptive point size.

The value represents size in meters, and should be between 0.001 m and 0.02 m. If the value is not within this range, it will be clamped. Default value is 0.003 m.

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getAdaptivePointSize()

float getAdaptivePointSize ( ) const

Gets the adaptive point size.

Default value is 0.003 m.

Returns
the adaptive point size.
Version
SCENE API Version 2.0.25.

◆ setPointColoring()

LSResult::Result setPointColoring ( const PointColoring  mode)

Sets the mode of PointColoring to be used in the view.

To turn this effect off simply pass PointColoring::NoColoring here. Default value is PointColoring::NoColoring

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getPointColoring()

PointColoring getPointColoring ( ) const

Gets the PointColoring setting.

Default value is PointColoring::NoColoring

Returns
the PointColoring setting
Version
SCENE API Version 2.0.25.

◆ setColoringRangeMin()

LSResult::Result setColoringRangeMin ( const Eigen::Vector4d &  min)

Sets the lower bound of the ranges used by the PointColoring effects.

Any coordinate coloring effect will use this value to calculate the lower limit of its ranges. These values don't represent actual coordinates, but rather offsets from the point returned by getReferenceOrigin().

min.x corresponds to the x cartesian coordinate. This value will be added to the ReferenceOrigin.x to determine the x coordinate where the coloring will start. min.y corresponds to the y cartesian coordinate. This value will be added to the ReferenceOrigin.y to determine the y coordinate where the coloring will start. min.z corresponds to the z cartesian coordinate. This value will be added to the ReferenceOrigin.z to determine the z coordinate where the coloring will start. min.w corresponds to the minimum distance used in PointColoring::CoordinateColoringDistance.

Default value is (0,0,0,0)

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getColoringRangeMin()

Eigen::Vector4d getColoringRangeMin ( ) const

Gets the lower bound of the ranges used by the PointColoring effects.

Any coordinate coloring effect will use this value to calculate the lower limit of its ranges.

See also
setColoringRangeMin

Default value is (0,0,0,0)

Returns
a vector of 4 values, xyz correspond to Cartesian coordinates used by coordinate coloring, while the fourth value corresponds to distance used by distance coloring
Version
SCENE API Version 2.0.25.

◆ setColoringRangeMax()

LSResult::Result setColoringRangeMax ( const Eigen::Vector4d &  max)

Sets the upper bound of the ranges used by the PointColoring effects.

Any coordinate coloring effect will use this value to calculate the upper limit of its ranges. These values don't represent actual coordinates, but rather offsets from the point returned by getReferenceOrigin().

max.x corresponds to the x Cartesian coordinate. This value will be added to the ReferenceOrigin.x to determine the x coordinate where the coloring will end. max.y corresponds to the y Cartesian coordinate. This value will be added to the ReferenceOrigin.y to determine the y coordinate where the coloring will end. min.z corresponds to the z Cartesian coordinate. This value will be added to the ReferenceOrigin.z to determine the z coordinate where the coloring will end. This number needs to be positive. min.w corresponds to the maximum distance used in PointColoring::CoordinateColoringDistance. Default value is (0,0,0,0)

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getColoringRangeMax()

Eigen::Vector4d getColoringRangeMax ( ) const

Gets the upper bound of the ranges used by the coloring effects.

Any coordinate coloring effect will use this value to calculate the upper limit of its ranges.

See also
setColoringRangeMax

Default value is (0,0,0,0)

Returns
a vector of 4 values, xyz correspond to Cartesian coordinates used by coordinate coloring, while the fourth value corresponds to distance used by distance coloring
Version
SCENE API Version 2.0.25.

◆ setBlendColoringWithPointColors()

LSResult::Result setBlendColoringWithPointColors ( const bool  blendColoringWithPointColorsEnabled)

Enables Coloring effects to be blended with point colors.

If this is set to false the point colors will be ignored, and only the coloring effect color will be rendered. Default value is true

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getBlendColoringWithPointColors()

bool getBlendColoringWithPointColors ( ) const

Gets whether the setting to blend Coloring effects with point colors is enabled or not.

If this is set to false the point colors will be ignored, and only the coloring effect color will be rendered. Default value is true

Returns
true if the setting is enabled, false otherwise
Version
SCENE API Version 2.0.25.

◆ setReferenceOrigin()

LSResult::Result setReferenceOrigin ( const Eigen::Vector3d &  origin)

Sets the origin used in coordinate coloring.

This setting has no visual effect if the PointColoring setting is disabled in the view. All coordinate coloring effects will calculate their distance from this point. In the case of PointColoring::CoordinateColoringDistance the function getCalculateDistanceFromCamera() should also return false for this coordinate to have any effect. The point passed as a parameter should be in the world coordinate system. Default value is (0,0,0)

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getReferenceOrigin()

Eigen::Vector3d getReferenceOrigin ( ) const

Sets the origin used in coordinate PointColoring.

This setting has no visual effect if the PointColoring setting is disabled in the view. All coordinate coloring effects will calculate their distance from this point. The point returned is in the world coordinate system.

See also
setRefereceOrigin() Default value is (0,0,0)
Returns
the reference origin
Version
SCENE API Version 2.0.25.

◆ setReferencePose()

LSResult::Result setReferencePose ( const Eigen::Matrix4f &  pose)

Sets the orientation of the colorization.

This setting has no visual effect if the PointColoring setting is disabled in the view. The user can pass a transformation matrix to set the pose. Usage:

// Rotate the colorization around x, 90 degrees.
Eigen::AngleAxis<float> aa(M_PI / 2, Eigen::Vector3f(1, 0, 0)); // Create a rotation matrix
Eigen::Matrix4f transformationMat = Eigen::Matrix4f::Identity(); // Create a transformation matrix
transformationMat.block(0, 0, 3, 3) = aa.toRotationMatrix(); // Inject rotation matrix to transformation matrix
viewSettings->setReferencePose(transformationMat); // Set reference pose as this.

Default value is identity matrix, which would end up in world coordinates.

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getReferencePose()

Eigen::Matrix4f getReferencePose ( ) const

Gets the orientation of the colorization.

Default value is the identity matrix.

Returns
the transformation matrix containing the orientation of the PointColoring effect.
Version
SCENE API Version 2.0.25.

◆ setDiscreteColors()

LSResult::Result setDiscreteColors ( const bool  discreteColorsEnabled)

Enables/disables the discrete option for the coordinate colorization.

If this setting is on, the view will display the coloring effect in discrete intervals. Set the amount of intervals with setNumOfDiscreteColors(). Default value is false

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getDiscreteColors()

bool getDiscreteColors ( ) const

Gets whether the discrete option is enabled for the coordinate colorization.

If this setting is on the view will display the coloring effect in discrete intervals. Default value is false

Returns
true if discrete colors is enabled, false otherwise.
Version
SCENE API Version 2.0.25.

◆ setNumOfDiscreteColors()

LSResult::Result setNumOfDiscreteColors ( const unsigned int  numOfColors)

Sets the number of intervals used for coordinate colorization.

This setting has no visual effect if the PointColoring setting or the DiscreteColors setting is disabled in the view. Pass a value in the range [2,50] here. If the value is not within the range, it will be clamped. Default value is 10

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getNumOfDiscreteColors()

unsigned int getNumOfDiscreteColors ( ) const

Gets the number of intervals used in PointColoring.

Default value is 10

Returns
the number of intervals used in discrete colorization
Version
SCENE API Version 2.0.25.

◆ setColorMap()

LSResult::Result setColorMap ( const ColorMap  mode)

Sets the type of ColorMap that will be used in colorization.

This setting has no visual effect if the PointColoring setting is disabled in the view. Default value is ColorMap::Rainbow

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getColorMap()

ColorMap getColorMap ( ) const

Gets the type of ColorMap used in PointColoring effects.

Default value is ColorMap::Rainbow

Returns
the ColorMap currently enabled.
Version
SCENE API Version 2.0.25.

◆ setCalculateDistanceFromCamera()

LSResult::Result setCalculateDistanceFromCamera ( const bool  distanceFromCamera)

Sets the setting for the origin for the mode PointColoring::CoordinateColoringDistance Setting this to true will use the camera as the origin from which the distance is calculated.

Otherwise the value returned by getReferenceOrigin() will be used Default value is true

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getCalculateDistanceFromCamera()

bool getCalculateDistanceFromCamera ( ) const

Gets the setting for the origin for the mode PointColoring::CoordinateColoringDistance If this value is true the mode PointColoring::CoordinateColoringDistance will use the camera as the origin from which the distance is calculated.

Otherwise the value returned by getReferenceOrigin() will be used. Default value is true

Returns
true if distance from the camera is being used, false if distance from the value returned by getReferenceOrigin() is being used
Version
SCENE API Version 2.0.25.

◆ setShading()

LSResult::Result setShading ( const Shading  mode)

Sets the mode of Shading to be used in the view.

To turn shading off pass Shading::NoShading here. Default value is Shading::NoShading

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getShading()

Shading getShading ( ) const

Gets the mode of Shading used in the view.

Default value is Shading::NoShading

Returns
the Shading mode currently active
Version
SCENE API Version 2.0.25.

◆ setApplyShadingTo()

LSResult::Result setApplyShadingTo ( const ApplyShadingTo  mode)

If any shading effect is enabled this will set whether this is applied to meshes, points, or both Default value is ApplyShadingTo::Both.

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getApplyShadingTo()

ApplyShadingTo getApplyShadingTo ( ) const

Gets what type of objects Shading effects are applied to Default value is ApplyShadingTo::Both.

Returns
what type of objects Shading effects are applied to
Version
SCENE API Version 2.0.25.

◆ setShadingStrength()

LSResult::Result setShadingStrength ( const uint8_t  shadingStrength)

Sets the shading strength setting used by shading effects Pass a value from 1 (small effect) to 5 (intense effect).

In case the value passed here is not within the range [1,5] it will be clamped. Default value is 3

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getShadingStrength()

uint8_t getShadingStrength ( ) const

Gets the shading strength setting used by Shading effects.

The value returned ranges from 1 (small effect) to 5 (intense effect).

Returns
the shading strength as an integer from 1 to 5.
Version
SCENE API Version 2.0.25.

◆ setPostProcess()

LSResult::Result setPostProcess ( const PostProcess  mode)

Enables a post-process effect for the view, e.g.

clear view, gap filling To disable such effects simply call this function with PostProcess::NoPostProcess Default value is PostProcess::NoPostProcess

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getPostProcess()

PostProcess getPostProcess ( ) const

Gets the PostProcess setting.

Default value is PostProcess::NoPostProcess

Returns
the PostProcess setting.
Version
SCENE API Version 2.0.25.

◆ setTransparencyFactor()

LSResult::Result setTransparencyFactor ( const float  factor)

Sets the transparency factor for clear view rendering.

Value of 1.0f means max opacity, while value of 0.0 means max transparency. The function accepts any value, but it is clamped in the range [0.0f, 1.0f]. This setting has no visual effect if PostProcess::ClearView is not set. Default value is 0.2f

Returns
LSResult::Result::Ok if the operation was successful
Version
SCENE API Version 2.0.25.

◆ getTransparencyFactor()

float getTransparencyFactor ( ) const

Gets the transparency factor for clear view rendering.

Value of 1.0f means max opacity, while value of 0.0f means max transparency. Default value is 0.2f

Returns
the transparency factor for clear view rendering.
Version
SCENE API Version 2.0.25.