Click or drag to resize

FBDynamicConnector Class

[Missing <summary> documentation for "T:Demo3D.Visuals.FBDynamicConnector"]

Inheritance Hierarchy

Namespace:  Demo3D.Visuals
Assembly:  Demo3D.Core (in Demo3D.Core.dll) Version: 11.0.0.7658
Syntax
C#
public class FBDynamicConnector : DynamicConnector

The FBDynamicConnector type exposes the following members.

Constructors
  NameDescription
Public methodFBDynamicConnector
Initializes a new instance of the FBDynamicConnector class
Top
Properties
  NameDescription
Public propertyAlignmentStyle

Field Value

Type: 
Defines the manner in which objects align to each other when snapped together.
(Inherited from Connector.)
Public propertyAllowed

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertyAllowsTransferIn

Field Value

Type: 
Indicates whether this connector allows inbound transfers, i.e., TransferDirection == In or InOut.
(Inherited from Connector.)
Public propertyAllowsTransferOut

Field Value

Type: 
Indicates whether this connector allows outbound transfers, i.e., TransferDirection == Out or InOut.
(Inherited from Connector.)
Public propertyAutoConfigure

Field Value

Type: 
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).
(Inherited from Connector.)
Public propertyAutoConnect

Field Value

Type: 
If true then connector will snap to other connectors with AutoConnect enabled when brought close together (see also SnapDistance)
(Inherited from Connector.)
Public propertyBoundaryOffset

Field Value

Type: 
The horizontal offset perpendicular to the connector.
(Inherited from Connector.)
Public propertyCenter

Field Value

Type: 
Mid-point between Start and End locations in the visual's space.
(Inherited from Connector.)
Public propertyConnectedTo
The first connector this connector is connected to, or null if no connected at all.
(Inherited from Connector.)
Public propertyConnectionWorldLocation

Field Value

Type: 
If connected then this is the effective location of the connection in world coordinates.
(Inherited from Connector.)
Public propertyConnectors
All connectors that are connected to this one.
(Inherited from Connector.)
Public propertyControlPointEnabled

Field Value

Type: 
If true, then the control point will be shown to indicate location, name and orientation of this connector.
(Inherited from Connector.)
Public propertyControlPointSize

Field Value

Type: 
Size of the control point, when enabled.
(Inherited from Connector.)
Public propertyDisallowed

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertyEnd

Field Value

Type: 
Location of end extent of the connector. The distance from Start to End defines the connector's width.
(Inherited from Connector.)
Public propertyHeightOffset

Field Value

Type: 
The vertical offset perpendicular to the connector.
(Inherited from Connector.)
Public propertyIsConnected
Is this connector connected to other connectors?
(Inherited from Connector.)
Public propertyKeepInBounds

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertyLength
Get the length of the connector.
(Inherited from 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.
(Inherited from Connector.)
Public propertyName
The name of the connector.
(Inherited from Connector.)
Public propertyNormal

Field Value

Type: 
Direction of the connector.
(Inherited from Connector.)
Public propertyParent (Inherited from DynamicConnector.)
Public propertyPosition (Inherited from DynamicConnector.)
Public propertyReparentOnConnect

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertySimulationTransferEnabled

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertySimulationTransferMotorVisual

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertySimulationTransferPadding

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertySimulationTransferRotateAfterAngle

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertySimulationTransferSize

Field Value

Type: 
In Linear Physics, if not zero, this value overrides the width of the outgoing conveyor for the transfer zone size.
(Inherited from Connector.)
Public propertySnapDistance

Field Value

Type: 
Distance at which AutoConnect (if set to True) will come into effect.
(Inherited from Connector.)
Public propertyStart

Field Value

Type: 
Location of start extent of the connector. The distance from Start to End defines the connector's width.
(Inherited from Connector.)
Public propertyTextHeight

Field Value

Type: 
Height of the text label on the connector.
(Inherited from Connector.)
Public propertyTransferDirection

Field Value

Type: 
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.
(Inherited from Connector.)
Public propertyType

Field Value

Type: 
Optional type value that allows the connector to be identified in the Allowed and Disallowed properties of other connectors
(Inherited from Connector.)
Public propertyWorldCenter
Get the center of the connector in world coordinates
(Inherited from Connector.)
Public propertyWorldEnd
Get the end of the connector in world coordinates.
(Inherited from Connector.)
Public propertyWorldNormal
The world normal of the connector.
(Inherited from Connector.)
Public propertyWorldStart
Get the start of the connector in world coordinates.
(Inherited from Connector.)
Top
Methods
  NameDescription
Public methodAddAspectT (Inherited from Connector.)
Public methodAlignConnectors
Align the parent of this connector to be in line with the connector it is connected to. Modify the transform of the parent of this connector to align to the Normal of the ConnectedTo connector. This doesn't do a centerSnap on the connectors and the alignment algorithm is Alignment.Closest.
(Inherited from Connector.)
Public methodAlignConnectors(ConnectorAlignment)
Align the parent of this connector to be in line with the connector it is connected to. Modify the transform of the parent of this connector to align to the Normal of the ConnectedTo connector. This doesn't do a centerSnap on the connectors.
(Inherited from Connector.)
Public methodAlignConnectors(ConnectorAlignment, Boolean)
Align the parent of this connector to be in line with the connector it is connected to. Modify the transform of the parent of this connector to align to the Normal of the ConnectedTo connector.
(Inherited from Connector.)
Public methodAngularDistanceFrom
Find distance between the world normals as the difference between their world-Y rotations, snapped to 5 degree increments
(Inherited from Connector.)
Public methodCanConnectTo
Indicate if the two Connectors may actually be connected. This allows connectors for different purposes. The GUI may use this to provide visual feedback when the user drags an object near to another object.
(Inherited from Connector.)
Public methodConnectTo(Connector, ConnectorAlignment)
Connect this and another connector together.
(Inherited from Connector.)
Public methodConnectTo(Connector, Boolean)
Connect two objects together. The method must take care of the placement and orientation of the respective visual objects.
(Inherited from Connector.)
Public methodConnectTo(Connector, Boolean, Boolean)
Connect two objects together. The method must take care of the placement and orientation of the respective visual objects.
(Inherited from Connector.)
Public methodConnectTo(Connector, ConnectorAlignment, Boolean, Boolean)
Connect this and another connector together.
(Inherited from Connector.)
Public methodConnectTo(Connector, Boolean, Boolean, Boolean)
Connect two objects together. The method must take care of the placement and orientation of the respective visual objects.
(Inherited from Connector.)
Public methodConnectTo(Connector, ConnectorAlignment, Boolean, Boolean, Action)
Connect this and another connector together (Only usable from C# scripting, not JScript).
(Inherited from Connector.)
Public methodDisconnectAll
Disconnect all connectors
(Inherited from Connector.)
Public methodDisconnectFrom
Disconnect two objects from each other. The orientation is left the same after disconnection.
(Inherited from Connector.)
Public methodDistanceFrom
Calculates the distance of the centers of this connector to the extents (start->end) of another connector.
(Inherited from Connector.)
Public methodFindAspectT (Inherited from Connector.)
Public methodIsConnectedTo(Connector)
Is this connector connected to the other connector.
(Inherited from Connector.)
Public methodIsConnectedTo(Visual)
Is this connector connected to the other visual via one of its connectors.
(Inherited from Connector.)
Protected methodLocation (Overrides DynamicConnectorLocation(Int32, Int32).)
Public methodRemoveAspectT (Inherited from Connector.)
Public methodToString
Connected "name:visual" string.
(Inherited from Connector.)
Public methodToVisualLocation
The center of the connector as a VisualLocation.
(Inherited from Connector.)
Protected methodUpdate (Inherited from DynamicConnector.)
Top
Events
  NameDescription
Public eventAfterDisconnectedListeners
Called just after this connector is disconnected from.
(Inherited from Connector.)
Public eventConnectedListeners
Called when this connector is connected to.
(Inherited from Connector.)
Public eventDisconnectedListeners
Called just before this connector is disconnected from.
(Inherited from Connector.)
Top
See Also