`BaseSop`#

class ansys.speos.core.opt_prop.BaseSop(sop_template, mat_inst, sop_parameters=None, stable_ctr=False)#

Base class for Surface Optical Property helpers.

Notes

This is a superclass and is not intended to be instantiated directly.

Parameters:

sop_template (ansys.speos.core.kernel.sop_template.ProtoSOPTemplate)
mat_inst (ansys.speos.core.kernel.scene.ProtoScene.MaterialInstance)
sop_parameters (Optional[Union[ansys.speos.core.generic.parameters.SopMirrorParameters, ansys.speos.core.generic.parameters.SopLibraryParameters, ansys.speos.core.generic.parameters.SopTypes.optical_polished]])

Overview#

Methods

`set_surface_mirror`	Define SOP as a perfect specular surface.
`set_surface_opticalpolished`	Set SOP to transparent or perfectly polished surface (e.g. glass).
`set_surface_library`	Configure SOP to use a library file.

Properties

`sop_mirror`	Mirror helper for the current SOP template.
`sop_library`	SOP library parameters when SOP is of library type.

from ansys.speos.core.opt_prop import BaseSop

property BaseSop.sop_mirror: BaseSop | None#

Mirror helper for the current SOP template.

Returns:

Optional[ansys.speos.core.opt_prop.BaseSop.SopMirror]: Mirror helper when the active SOP field is mirror, otherwise None.

property BaseSop.sop_library: BaseSop | None#

SOP library parameters when SOP is of library type.

Returns:

Optional[ansys.speos.core.opt_prop.BaseSop.SopLibrary]: Library helper containing sop_file_uri when SOP is of library type, otherwise None.

BaseSop.set_surface_mirror()#

Define SOP as a perfect specular surface.

Returns:

ansys.speos.core.opt_prop.BaseSop.SopMirror: Returns mirror helper for chaining.

BaseSop.set_surface_opticalpolished()#

Set SOP to transparent or perfectly polished surface (e.g. glass).

Returns:

BaseSop.set_surface_library()#

Configure SOP to use a library file.

Returns:

ansys.speos.core.opt_prop.BaseSop.SopLibrary: Returns library helper for chaining.

`SopMirror`	Mirror SOP parameters.
`SopLibrary`	Library SOP parameters.