FreeSpaceMedium
The default free space medium.
Example
app = cf.GetApplication() project = app:NewProject() -- Create a cuboid cube1 = project.Geometry:AddCuboid(cf.Cuboid.GetDefaultProperties()) -- Set the region medium to free space cube1.Regions[1].Medium = project.Media:GetFreeSpace()
Inheritance
The FreeSpaceMedium object is derived from the Medium object.
Property List
Method List
- AddToLibrary ()
- Add the medium to the media library.
- Delete ()
- Delete the medium.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- SetNotSuspect ()
- Reset the suspect setting on the medium.
- SetProperties (properties table)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Property Details
Method Details
- AddToLibrary ()
- Add the medium to the media library.
- Delete ()
- Delete the medium.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A properties table.
- SetNotSuspect ()
- Reset the suspect setting on the medium.
- SetProperties (properties table)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(table)
- A table of properties defining the new state of the object.