AllCharacteristics#

class ansys.speos.core.simulation.SimulationVirtualBSDF.AllCharacteristics(mode_template, default_values=True, stable_ctr=False)#

BSDF depends on all properties mode of BSDF bench measurement.

By default, is_bsdf180 is false reflection_and_transmission is false Color does not depend on viewing direction is set Source sampling is set to be isotropic

Parameters:
mode_templatesimulation_template_pb2.AllCharacteristics

all properties dependent BSDF settings to complete.

default_valuesbool

Uses default values when True as not bsdf180 and reflection only.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:
  • mode_template (ansys.api.speos.simulation.v1.simulation_template_pb2.VirtualBSDFBench)

  • default_values (bool)

  • stable_ctr (bool)

Overview#

set_non_iridescence

Set bsdf color does not depend on viewing direction.

set_iridescence

Set bsdf color depends on viewing direction.

is_bsdf180

Boolean value if bsdf to be generated is bsdf180 or not.

reflection_and_transmission

Boolean value if bsdf to be generated is bsdf180 or not.

Import detail#

from ansys.speos.core.simulation.SimulationVirtualBSDF import AllCharacteristics

Property detail#

property AllCharacteristics.is_bsdf180: bool#

Boolean value if bsdf to be generated is bsdf180 or not.

This property gets or sets the boolean if the virtual bsdf bench is going to generate one bsdf180 file or not.

Parameters:
value: bool

True if bsdf180 is to be generated, False otherwise.

Returns:
bool

True if bsdf180 is to be generated, False otherwise.

property AllCharacteristics.reflection_and_transmission: bool#

Boolean value if bsdf to be generated is bsdf180 or not.

This property gets or sets the boolean if the virtual bsdf bench is going to generate both reflection and transmission or only reflection bsdf.

Parameters:
value: bool

True if reflection and transmission is to be generated, False otherwise.

Returns:
bool

True if reflection and transmission is to be generated, False otherwise.

Method detail#

AllCharacteristics.set_non_iridescence()#

Set bsdf color does not depend on viewing direction.

Returns:
ansys.speos.core.simulation.SimulationVirtualBSDF.AllCharacteristics.NonIridescence

NonIridescence settings to be complete

AllCharacteristics.set_iridescence()#

Set bsdf color depends on viewing direction.

Returns:
ansys.speos.core.simulation.SimulationVirtualBSDF.AllCharacteristics.Iridescence

Iridescence settings to be complete

Classes#

Iridescence

Color depends on viewing direction of BSDF measurement settings.

NonIridescence

Color does not depend on viewing direction of BSDF measurement settings.