`UnprotectedInformation`

Provides public information about the protected component.

Example

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

workplane = project.Definitions.Workplanes:Add(cf.Point(1, 1, 1), cf.Point(1, 0, 0), cf.Point(0, 0, 1))

line = project.Contents.Geometry:AddLine(cf.Point(0, 0, -1), cf.Point(0, 0, 1))
port = project.Contents.Ports:AddWirePort(line.Wires[1])

-- Grant access to workplane and port
project.UnprotectedInformation:GrantAccess({workplane, port})

Inheritance

The UnprotectedInformation object is derived from the Object object.

Usage locations

The UnprotectedInformation object can be accessed from the following locations:

Properties

Property List

AccessibleEntities: The list of entities accessible by client models. (Read/Write ObjectReferenceList)
BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Label: The object label. (Read/Write string)
Locked: A boolean that indicates whether the entity or it's ancestor is locked or not. (Read/Write boolean)
Type: The object type string. (Read only string)

Collection List

Representation: The collection of geometry used to provide rendering to client models. (RepresentationGeometryCollection of Geometry.)

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.)
GrantAccess (entityList List of Object): Grants client access to the entities.
RevokeAccess (entityList List of Object): Revokes client access from the entities.
RevokeAllAccess (): Revokes client access from all entities.
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

AccessibleEntities

The list of entities accessible by client models.

Type: ObjectReferenceList
Access: Read/Write

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Locked

A boolean that indicates whether the entity or it's ancestor is locked or not.

Type: boolean
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Collection Details

Representation

The collection of geometry used to provide rendering to client models.

Type: RepresentationGeometryCollection

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.

GrantAccess (entityList List of Object)

Grants client access to the entities.

Input Parameters

entityList(List of Object): The list of entities that must be made accessible to client models.

RevokeAccess (entityList List of Object)

Revokes client access from the entities.

Input Parameters

entityList(List of Object): The list of entities to revoke client access.

RevokeAllAccess ()

Revokes client access from all entities.

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.