Click or drag to resize

Connector Properties

The Connector type exposes the following members.

Properties
  NameDescription
Public propertyAlignmentStyle
Defines the manner in which objects align to each other when snapped together.
Public propertyAllowed
List of connector Types that are allowed to connect with this connector. If empty then all connectors are allowed, as long as they are not named explicitly in the Disallowed list.
Public propertyAllowsTransferIn
Indicates whether this connector allows inbound transfers, i.e., TransferDirection == In or InOut.
Public propertyAllowsTransferOut
Indicates whether this connector allows outbound transfers, i.e., TransferDirection == Out or InOut.
Public propertyAutoConfigure
If true, then the visual will reconfigure the connector to the built-in defaults upon reset. Set this to false if you have modified one of the built-in connectors (for example, "Start" on a conveyor).
Public propertyAutoConnect
If true then connector will snap to other connectors with AutoConnect enabled when brought close together (see also SnapDistance)
Public propertyBoundaryOffset
The horizontal offset perpendicular to the connector.
Public propertyBoundingBox
Public propertyBoundingSphere
Public propertyCenter
Mid-point between Start and End locations in the visual's space.
Public propertyConnectedTo
The first connector this connector is connected to, or null if no connected at all.
Public propertyConnectionWorldLocation
If connected then this is the effective location of the connection in world coordinates.
Public propertyConnectors
All connectors that are connected to this one.
Public propertyControlPointEnabled
If true, then the control point will be shown to indicate location, name and orientation of this connector.
Public propertyControlPointSize
Size of the control point, when enabled.
Public propertyDisallowed
List of connector Types that are not allowed to connect to this connector. If a Type appears in both Allowed and Disallowed, then Disallowed takes priority, and the Type is disallowed.
Public propertyDocument
Public propertyEnd
Location of end extent of the connector. The distance from Start to End defines the connector's width.
Public propertyHeightOffset
The vertical offset perpendicular to the connector.
Public propertyIsConnected
Is this connector connected to other connectors?
Public propertyIsOptimized
Public propertyKeepInBounds
With AutoConnect=True, then the snapping action also allows the visual with the shortest connector (distance from Start to End) to slide along the length of the longer partner connector (on the other visual). The KeepInBounds property (of the longer connector) defines whether the longer connector will allow the shorter connector to extend its length beyond the length of the longer connector.
Public propertyLayerIsVisible
Public propertyLength
Get the length of the connector.
Public propertyMaxAllowedConnections
Optional limit to the number of connectors that this connector can connect to. This is int.MaxValue by default making it effectively unlimited.
Public propertyName
The name of the connector.
Public propertyNormal
Direction of the connector.
Public propertyParent
The Visual that owns this connector.
Public propertyReparentOnConnect
When true, the owning visual will be reparented to the partner connector's owning visual. This is useful for creating components such as interchangeable robot end-effectors, which need to become part of the robot component when snapped into position.
Public propertySimulationTransferEnabled
When true, in Linear Physics, a virtual sensor and stop blade are added to the ongoing conveyor that this conveyor will merge into via this outgoing connector. This enables a simple level of overlap avoidance without adding in explicit sensors and stops by hand.
Public propertySimulationTransferMotorVisual
In Linear Physics, this indicates the motor visual to use for the transfer speed of loads. If not set then it defaults to conveyor that owns the connector.
Public propertySimulationTransferPadding
In Linear Physics, if SimulationTransferEnabled is true, this extends the sensor on the next conveyor back this distance. This allows the next conveyor to act as a main line and not block while a load is being transferred from this conveyor. This cannot be negative as that would cause loads to overlap.
Public propertySimulationTransferRotateAfterAngle
In Linear Physics, if the angle between two conveyors is less than this number then the load will transfer be in the same orientation it is in on the current conveyor. If the angle is greater than this number then the load will be rotated by 90 degrees. Set this to 180 to prevent loads rotating from their current orientation. The default is 80 degrees.
Public propertySimulationTransferSize
In Linear Physics, if not zero, this value overrides the width of the outgoing conveyor for the transfer zone size.
Public propertySnapDistance
Distance at which AutoConnect (if set to True) will come into effect.
Public propertySnapStyle
Defines the manner in which objects snap to each other when connecting.
Public propertyStart
Location of start extent of the connector. The distance from Start to End defines the connector's width.
Public propertyTextHeight
Height of the text label on the connector.
Public propertyTransferDirection
Used by the Transfer protocol (as implemented in many QuickStart components) to define in which direction this connector allows transfers to take place. A value of "In" means that the component receive loads on this connector. A value of "Out" means that the component will deliver loads on this connector. A value of "InOut" means the component will receive and deliver loads on this component. A value of "None" means that the component will neither receive nor deliver loads on this connector. For example, "Start" connectors usually have this property set to "In"; "End" connectors usually have it set to "Out"; "Left" and "Right" connectors might have it set to "InOut"; connectors that are used for snapping end-effectors (for example) would have it set to "None", since they are not used for transferring loads. The component will consider the TransferDirection of the partner connector to find the effective TransferDirection; for example, if this connector is set to "In", then the other connector must be set to "Out" or "InOut" for a transfer to be possible.
Public propertyType
Optional type value that allows the connector to be identified in the Allowed and Disallowed properties of other connectors
Public propertyWorldCenter
Get the center of the connector in world coordinates
Public propertyWorldEnd
Get the end of the connector in world coordinates.
Public propertyWorldMatrix
Public propertyWorldNormal
The world normal of the connector.
Public propertyWorldStart
Get the start of the connector in world coordinates.
Top
See Also