ModelAttributes
The model attributes.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Modify the unit of the model to mm project.ModelAttributes.Unit = cf.Enums.ModelUnitEnum.Millimetres
Inheritance
The ModelAttributes object is derived from the Object object.
Usage locations
The ModelAttributes object can be accessed from the following locations:
- Properties
- Model object has property ModelAttributes.
Property List
- Label
- The object label. (Read/Write string)
- Type
- The object type string. (Read only string)
- Unit
- The unit used for all distances and dimensions specified by the ModelUnitEnum, e.g. Meters, Feet, etc. (Read/Write ModelUnitEnum)
- UnitFactor
- An arbitrary unit conversion factor with respect to metres. The value is only valid when ModelUnit is set to Specified. (Read/Write ParametricExpression)
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
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Unit
- The unit used for all distances and dimensions specified by the ModelUnitEnum, e.g. Meters, Feet, etc.
- Type
- ModelUnitEnum
- Access
- Read/Write
- UnitFactor
- An arbitrary unit conversion factor with respect to metres. The value is only valid when ModelUnit is set to Specified.
- Type
- ParametricExpression
- Access
- Read/Write
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.