EntityIDs
Description
A chain of entities by entity ID of existing geometry items in the BobCAD entity database. The ID's do not need to be in any specific order, as BobCAD will automatically form them into a chain.
Keys
The overall structure of a chain formed by Entity IDs is a table with the following keys defined:
- CmdName – The name that will be displayed in the Undo/Redo list – This can be excluded if using the Bcc.StartUndo() and Bcc.EndUndo()
- Type="EntityIDs" - defines the type of chain to be a list of existing entity IDs.
- List - a table containing the entity IDs to be used to form a chain
- Tolerance - optional key value that defines the tolerance used for breaking certain entity types like a Text entity. This value is not used for a majority of entity types. The CAD system tolerance in BobCAD will be used if not defined.
- ChainGapTolerance - optional key value that can be specified to define the tolerance of matching entity vertices when forming the chain since the entity ID's do not need to be in a specific order. The chain selection tolerance defined in BobCAD will used if this key is not defined.
- Color – the entity color can be specified using either the color name or the hexadecimal color value
- Color = “Red”
- Color = “#E400FF”
- Layer – The name of the layer to create the entity on
- Can be an existing layer or if does not exist the layer will be created
- if this is omitted the entity is created on the currently active layer in BobCAD
- LineStyle -The entity line style used. Possible values can be:
- None – This will utilize the active document linestyle – Same as omitting this parameter
- Solid
- Dash
- Dot
- DashDot
- DashDotDot
NOTE: The color, layer, linestyle, pointstyle defined in the individual entity will overwrite any attributes that are defined for the chain in this command
- TransformMatrix - A 4x4 matrix can be specified to transform the given entities coordinates
- TransformMatrix = {{1,0,0,0},{0,1,0,0},{0,0,1,0},{10,10,0,0}}
Example
-- Get the selected entities in the workspace
retTable = Bcc.GetSelectedEntities(true)
-- define the entity list
myEntityIDList = { CmdName="EntityIDList", Type="EntityIDs", List=retTable }