MediaLibrary

The media library of predefined and user defined media.

Example

app = cf.GetApplication()
project = app:NewProject()
    
    -- Add a medium from the media library
    
diel1 = project.Media.Library:AddToModel("Aluminium")

Usage locations (object properties)

The following objects have properties using the MediaLibrary object:

Property List

FEKOMediaLabels
The label list of predefined media. (Read only List of string)
Type
The object type string. (Read only string)
UserMediaLabels
The label list of user defined media. (Read only List of string)

Method List

Add (medium Medium)
Add the given model medium to the media library.
AddToModel (mediumname string)
Add a medium from the library to the CADFEKO model. (Returns a Medium object.)
AddToModelWithLabel (mediumname string, modellabel string)
Add a medium from the library to the CADFEKO model with a new label. (Returns a Medium object.)
Contains (label string)
Checks if the library contains a medium with the given label. (Returns a boolean object.)
Delete (label string)
Delete the user defined medium from the media library.
Replace (label string, medium Medium)
Replace the user defined medium in the media library.

Property Details

FEKOMediaLabels
The label list of predefined media.
Access
Read only
Type
The object type string.
Type
string
Access
Read only
UserMediaLabels
The label list of user defined media.
Access
Read only

Method Details

Add (medium Medium)
Add the given model medium to the media library.
Input Parameters
medium(Medium)
The medium to add to the library.
AddToModel (mediumname string)
Add a medium from the library to the CADFEKO model.
Input Parameters
mediumname(string)
The name of the library medium to add.
Return
Medium
The medium added to the model.
AddToModelWithLabel (mediumname string, modellabel string)
Add a medium from the library to the CADFEKO model with a new label.
Input Parameters
mediumname(string)
The name of the library medium to add.
modellabel(string)
The label that will be assigned to the medium.
Return
Medium
The medium added to the model.
Contains (label string)
Checks if the library contains a medium with the given label.
Input Parameters
label(string)
The label of the medium.
Return
boolean
The success of the check.
Delete (label string)
Delete the user defined medium from the media library.
Input Parameters
label(string)
The label of the user defined medium to delete.
Replace (label string, medium Medium)
Replace the user defined medium in the media library.
Input Parameters
label(string)
The label of the user defined medium to replace.
medium(Medium)
The new medium.