LibraryMedium
A medium from the MediaLibrary.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Add a medium from the media library diel1 = application.MediaLibrary:AddToModel("Aluminium")
Inheritance
The LibraryMedium object is derived from the Object object.
Usage locations
The LibraryMedium object can be accessed from the following locations:
- Methods
- MediaLibrary collection has method Item(number).
- MediaLibrary collection has method Item(string).
Property List
- Label
- The object label. (Read/Write string)
- Medium
- The medium. (Read/Write Medium)
- MediumType
- The type of medium. (Read/Write LibraryMediumTypeEnum)
- Source
- The source of the medium, either AltairFeko or User. (Read/Write LibraryMediumSourceEnum)
- Type
- The object type string. (Read only string)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- 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.)
- SetProperties (properties Object)
- 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.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Medium
- The medium.
- Type
- Medium
- Access
- Read/Write
- MediumType
- The type of medium.
- Type
- LibraryMediumTypeEnum
- Access
- Read/Write
- Source
- The source of the medium, either AltairFeko or User.
- Type
- LibraryMediumSourceEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- 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 table defining the properties.
- SetProperties (properties Object)
- 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(Object)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.