`MediaLibrary`

The media library of predefined and user defined media.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Add a medium from the media library

diel1 = application.MediaLibrary:AddToModel("Aluminium")

Inheritance

The MediaLibrary object is derived from the Object object.

Usage locations

The MediaLibrary object can be accessed from the following locations:

Collection lists
- Application object has collection MediaLibrary.

Property List

Count: The number of LibraryMedium items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

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.)
Delete (): Deletes the entity.
DeleteEntities ( List of Object): Delete the given list of entities from the collection.
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.)
Item (index number): Returns the LibraryMedium for the given index in the collection. (Returns a LibraryMedium object.)
Item (label string): Returns the LibraryMedium for the given label in the collection. (Returns a LibraryMedium object.)
Items (): Returns a table of LibraryMedium items. (Returns a UnsupportedType(List of LibraryMedium) object.)
Replace (label LibraryMedium, medium LibraryMedium): Replace the user defined medium in the media library.
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

Count

The number of LibraryMedium items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

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.

Delete ()

Deletes the entity.

DeleteEntities ( List of Object)

Delete the given list of entities from the collection.

Input Parameters

(List of Object)

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.

Item (index number)

Returns the LibraryMedium for the given index in the collection.

Input Parameters

index(number): The index of the LibraryMedium.

Return

LibraryMedium: The item in the collection

Item (label string)

Returns the LibraryMedium for the given label in the collection.

Input Parameters

label(string): The label of the LibraryMedium.

Return

LibraryMedium: The item in the collection

Items ()

Returns a table of LibraryMedium items.

Return

UnsupportedType(List of LibraryMedium): The list of items in the collection

Replace (label LibraryMedium, medium LibraryMedium)

Replace the user defined medium in the media library.

Input Parameters

label(LibraryMedium): The label of the user defined medium to replace.
medium(LibraryMedium): The new medium.

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.