DomainConnectivity
Domain connections between unconnected faces.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Create two un-connected rectangles project.Contents.Geometry:AddRectangle(cf.Point(0, 0, 0), 0.5, 0.5) project.Contents.Geometry:AddRectangle(cf.Point(0.52, 0, 0), 0.5, 0.5) -- Add a domain connection between the 2 rectangle faces domainConnectivity = cf.DomainConnectivity.GetDefaultProperties() domainConnectivity.Tolerance = "0.01" domainConnectivity.Connections[1] = {} domainConnectivity.Connections[1].FirstFace = "Rectangle1.Face1" domainConnectivity.Connections[1].SecondFace = "Rectangle2.Face2" application.Project.Contents.SolutionSettings.DomainConnections:Add(domainConnectivity)
Inheritance
The DomainConnectivity object is derived from the Object object.
Usage locations
The DomainConnectivity object can be accessed from the following locations:
- Methods
- DomainConnectivityCollection collection has method Add(table).
- DomainConnectivityCollection collection has method Item(number).
- DomainConnectivityCollection collection has method Item(string).
Property List
- Connections
- Pairs of geometry labels that should be treated as connected. (Read/Write DomainConnectionList)
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- Tolerance
- A tolerance/distance to differentiate between connections and gaps that should be maintained. (Read/Write ParametricExpression)
- Type
- The object type string. (Read only string)
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
- Connections
- Pairs of geometry labels that should be treated as connected.
- Type
- DomainConnectionList
- Access
- Read/Write
- Included
- A boolean value defining if an entity is excluded or included.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Tolerance
- A tolerance/distance to differentiate between connections and gaps that should be maintained.
- Type
- ParametricExpression
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
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.