ProtectedModel
A concealed password protected component.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Protect the model with a password. -- Note that it is required to do this through the user interface -- This is done to ensure passwords are not entered in plain text
Inheritance
The ProtectedModel object is derived from the Object object.
Usage locations
The ProtectedModel object can be accessed from the following locations:
- Methods
- ProtectedModels collection has method AddComponent(table).
- ProtectedModels collection has method AddComponent(string).
- ProtectedModels collection has method Item(number).
- ProtectedModels collection has method Item(string).
Property List
- AbsoluteFilePath
- The full path of the project file (directory path and file name including the file extension). (Read only string)
- AbsolutePath
- The full directory path of the project file (directory path excluding the file name and extension). (Read only string)
- AccessiblePorts
- The list of accessible ports avaliable from the protected component. (Read only List of Port)
- AccessibleWorkplanes
- The list of accessible workplanes avaliable from the protected component. (Read only List of Workplane)
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- Filename
- The file to be imported as a protected component. (Read/Write FileReference)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The source workplane. (Read/Write LocalWorkplane)
- Type
- The object type string. (Read only string)
Collection List
- Transforms
- The collection of transforms on the operator. (TransformCollection of Transform.)
Method List
- ConcealModel ()
- Conceals the component if it was exposed.
- CopyAndMirror (properties table)
- Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry. (Returns a List of Object object.)
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the geometry. (Returns a List of Object object.)
- 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.)
- ReloadModel ()
- Reloads the protected componenet from disk.
- 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
- AbsoluteFilePath
- The full path of the project file (directory path and file name including the file extension).
- Type
- string
- Access
- Read only
- AbsolutePath
- The full directory path of the project file (directory path excluding the file name and extension).
- Type
- string
- Access
- Read only
- AccessiblePorts
- The list of accessible ports avaliable from the protected component.
- Access
- Read only
- AccessibleWorkplanes
- The list of accessible workplanes avaliable from the protected component.
- Access
- Read only
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- Filename
- The file to be imported as a protected component.
- Type
- FileReference
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The source workplane.
- Type
- LocalWorkplane
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- Transforms
- The collection of transforms on the operator.
Method Details
- ConcealModel ()
- Conceals the component if it was exposed.
- CopyAndMirror (properties table)
- Apply a copy and mirror using a table defining the properties.
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties.
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry.
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties.
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the geometry.
- 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.
- ReloadModel ()
- Reloads the protected componenet from disk.
- 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.