Medium

A medium.

Example

 app = cf.GetApplication()
project = app:NewProject()

    -- Create a dielectric medium
    
dielectric = project.Media:AddDielectric(2.16, 0.001, 1000)

    -- Delete the dielectric medium
    
dielectric:Delete()

Inheritance

The following objects are derived (specialisations) from the Medium object:

Usage locations (object properties)

The following objects have properties using the Medium object:

Property List

Colour
The medium colour. (Read/Write Colour)
Label
The object label. (Read/Write string)
Suspect
Indicates whether the medium is suspect. (Read only boolean)

Method List

AddToLibrary ()
Add the medium to the media library.
Delete ()
Delete the medium.
SetNotSuspect ()
Reset the suspect setting on the medium.

Property Details

Colour
The medium colour.
Type
Colour
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
Suspect
Indicates whether the medium is suspect.
Type
boolean
Access
Read only

Method Details

AddToLibrary ()
Add the medium to the media library.
Delete ()
Delete the medium.
SetNotSuspect ()
Reset the suspect setting on the medium.