BaseVop

class ansys.speos.core.opt_prop.BaseVop(vop_template, mat_inst, vop_parameters=None, stable_ctr=False)

Base class for Volume Optical Property helpers.

Notes

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

Parameters:

• vop_template (Union[None, ansys.speos.core.kernel.vop_template.ProtoVOPTemplate])

• mat_inst (ansys.speos.core.kernel.scene.ProtoScene.MaterialInstance)

• vop_parameters (Optional[Union[ansys.speos.core.generic.parameters.VopTypes.none, ansys.speos.core.generic.parameters.VopTypes.opaque, ansys.speos.core.generic.parameters.VopLibraryParameters, ansys.speos.core.generic.parameters.VopOpticParameters]])

Overview

Methods

set_volume_none	Remove any VOP template (no volume optical property).
set_volume_opaque	Set VOP to non-transparent (opaque) material.
set_volume_optic	Set VOP to a transparent, non-scattering optic.
set_volume_library	Set VOP to use a library file.

Properties

vop_optic	Optic parameters for a clear transparent volume.
vop_library	Library parameters when VOP is of library type.

Import detail

from ansys.speos.core.opt_prop import BaseVop

Property detail

property BaseVop.vop_optic: BaseVop | None

Optic parameters for a clear transparent volume.

Returns:

Optional[ansys.speos.core.opt_prop.BaseVop.VopOptic]

Optic helper containing index, absorption, and constringence when VOP is of optic type, otherwise None.

property BaseVop.vop_library: BaseVop | None

Library parameters when VOP is of library type.

Returns:

Optional[ansys.speos.core.opt_prop.BaseVop.VopLibrary]

Library helper containing material_file_uri when VOP is of library type, otherwise None.

Method detail

BaseVop.set_volume_none()

Remove any VOP template (no volume optical property).

Returns:

ansys.speos.core.opt_prop.OptProp

Returns self (as the OptProp that owns this VOP helper).

BaseVop.set_volume_opaque()

Set VOP to non-transparent (opaque) material.

Returns:

ansys.speos.core.opt_prop.OptProp

Returns self (as the OptProp that owns this VOP helper).

BaseVop.set_volume_optic()

Set VOP to a transparent, non-scattering optic.

Returns:

ansys.speos.core.opt_prop.BaseVop.VopOptic

Returns VOP Helper.

BaseVop.set_volume_library()

Set VOP to use a library file.

Returns:

ansys.speos.core.opt_prop.BaseVop.VopLibrary

Returns VOP Library helper.

Classes

VopOptic	Optic parameters for a clear transparent volume.
VopLibrary	Helper class for library VOP parameters.