Stop |
The StopBladeVisual type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllAspects |
Returns all the aspects for this Visual.
(Inherited from CoreVisual) |
| AllConnectors | Gets all connectors. (Inherited from Visual) |
| AllowWaitOnMove | When true, allows scripting to wait for the OnMoved event. This is false by default to avoid performance degradation for visuals that move frequently.
<p>
Example scripting:
<pre>
sender.AllowWaitOnMove = true;
Wait( sender.OnMoved );
</pre> (Inherited from Visual) |
| Ancestors |
Return all ancestor visuals above this point in the Visual hierarchy.
(Inherited from Visual) |
| AngularVelocity |
The current angular velocity of the Visual in radians/second.
(Inherited from Visual) |
| AnimatorInProgress |
Determine if any animations are currently in progress for this Visual.
(Inherited from Visual) |
| App |
The global application object.
(Inherited from Visual) |
| Billboard | If true, then the visual will always face the camera. This is useful for text that should always face the user, for example.
<p>
Note that the visual's Rotation property will be set automatically, and so will overwrite any updates made from scripting or from the property grid. (Inherited from Visual) |
| BillOfMaterialsCodeExpr | The catalog order code of the component as it appears in the bill of materials, e.g. "'XYZ-203-37.TZ1'". If this is blank there will be no entry in the bill of materials for this component. (Inherited from Visual) |
| BillOfMaterialsCostExpr | The cost of the component as it appears in the bill of materials, e.g. "1595.95". (Inherited from Visual) |
| BillOfMaterialsDescriptionExpr | The description of the component as it appears in the bill of materials, e.g. "Driven Roller Module". If this is blank there will be no entry in the bill of materials for this component. (Inherited from Visual) |
| BladeState | Whether the blade is Up, Down or InTransit. |
| BoundingBox |
Get the bounding box of this visual including all its children.
(Inherited from Visual) |
| BoundingBoxExcludingChildren | (Inherited from MeshObject) |
| BoundingSphere |
Get the bounding sphere of this visual, including its children.
(Inherited from Visual) |
| BoundingSphereExcludingChildren | (Inherited from MeshObject) |
| CastsShadow | Shows whether this object casts a shadow or not. Useful for large objects such as warehouses where the walls shouldn't cast shadows on the conveyors. (Inherited from MeshObject) |
| Children |
Return the collection of child Visuals.
(Inherited from Visual) |
| ClientOwnerUsername | (Inherited from Visual) |
| Color | Set or retrieve the color of the material. |
| Colors |
The diffuse colors of the all the mesh materials on the mesh object.
(Inherited from MeshObject) |
| ConnectAllowed | A list of visual Types that are allowed to connect to this visual. If empty, then all visuals are allowed to connect, provided they are not specified in the ConnectDisallowed list, and that the connector-specific rules also allow the connection.
<p>
See also:
<ul>
<li>Demo3D.Visuals.Visual.ConnectDisallowed
<li>Demo3D.Visuals.Connector.Allowed
<li>Demo3D.Visuals.Connector.Disallowed
</ul>
(Inherited from Visual) |
| ConnectDisallowed | A list of visual Types that are not allowed to connect to this visual. If a Type appears in both ConnectAllowed and ConnectDisallowed, then ConnectDisallowed takes priority and the connection is not allowed.
<p>
See also:
<ul>
<li>Demo3D.Visuals.Visual.ConnectAllowed
<li>Demo3D.Visuals.Connector.Allowed
<li>Demo3D.Visuals.Connector.Disallowed
</ul>
(Inherited from Visual) |
| ConnectorPairs |
All pairs of connectors from this visual.
(Inherited from Visual) |
| ContactLatch | |
| ControlPointsAllowed | A white list of control points that should be shown and editable. (Inherited from Visual) |
| ControlPointsDisallowed | A black list of control points that should be hidden and not editable. (Inherited from Visual) |
| CSGOperations | (Inherited from MeshObject) |
| CurrentBladePosition | How much above the conveyor surface the stop blade is currently. A negative position is below the conveyor surface. |
| CurrentRoutingTarget |
The current destination for this visual (usually a load).
This can be used by equipment to decide which direction to transfer a load, or it can be ignored.
It is specific to the equipment processing the load.
(Inherited from Visual) |
| CurrentStation |
The Visual that the load is current at waiting to be ordered.
Any Visual can be a Station but LoadCreatorVisual the first station set when calling LoadCreatorVisual.OrderLoad().
This is normally set for loads.
(Inherited from Visual) |
| CurrentTransfer |
Information about the current transfer in progress for this visual using the Transfer Protocol.
This is normally set for loads.
(Inherited from Visual) |
| CustomProperties |
The collection of CustomProperty objects for this Visual.
(Inherited from Visual) |
| Density | The density of the stop blade. |
| Depth | The depth of the stop blade. |
| Descendants |
Return all visuals below this point in the Visual hierarchy .
(Inherited from Visual) |
| DescendantsDepthFirst |
Return all visuals below this point in the Visual hierarchy .
(Inherited from Visual) |
| Description |
A description of the Visual.
(Inherited from Visual) |
| Document |
The document that this Visual belongs to.
(Inherited from Visual) |
| Draggable |
Whether the visual be dragged using the mouse.
(Inherited from Visual) |
| FaceCount |
Number of triangular faces in the mesh
(Inherited from MeshObject) |
| FaceCountDeep |
Number of faces in Mesh for Visual and all its children.
(Inherited from Visual) |
| FirstChild |
The first child visual of this visual, or null if this visual has no children.
(Inherited from Visual) |
| FixToParent | For a load or vehicle this will create a fixed joint between it and its parent unless there is another joint in the way. This should be true for creating composite loads or vehicles or false where there is just a logical connection to the parent, e.g. boxes in a tote. (Inherited from Visual) |
| FrictionMaterial | The name of the material to be use to determine the coefficient of friction when in contact with another friction material. |
| FullName |
The full name of this Visual, including the names of all Parent Visual separated by '.' characters.
(Inherited from Visual) |
| HasChildren |
Determine if this Visual has any children or not.
(Inherited from Visual) |
| HasNextSibling |
Determine if this Visual has any siblings or not.
(Inherited from Visual) |
| Height | The height of the stop blade. |
| HideAdvancedProperties | (Inherited from Visual) |
| HierarchyColor | The background color of the Visual in the hierarchy (Inherited from Visual) |
| Id |
A unique identifier for this Visual.
(Inherited from Visual) |
| IncludeChildContextMenus | When right clicking on the object should child objects menu items be included. Default is false. (Inherited from Visual) |
| InitialBladeState | The initial position of the blade on reset (Up, Down or AsIs) |
| InitialLocation |
The InitialLocation of the Visual in meters from the Origin of the Parent Visual.
(Inherited from Visual) |
| InitialMatrix |
The InitialLocation and InitialRotation in Matrix form.
(Inherited from Visual) |
| InitialParentOnReset | The parent that should be assigned upon reset. This is useful for vehicle-type components that should reset their position to a particular track section, for example. Note this is only applied if InitialPositionOnReset is set to True. (Inherited from Visual) |
| InitialPositionOnReset | Moves the visual back to its initial location and rotation when Reset is pressed. (Inherited from Visual) |
| InitialRotationDegrees |
The InitialRotation of the Visual in degrees relative to the Rotation of Parent Visual.
(Inherited from Visual) |
| InitialRotationMatrix |
The InitialRotation in Matrix form.
(Inherited from Visual) |
| InitialRotationRadians |
The InitialRotation of the Visual in radians relative to the Rotation of Parent Visual.
(Inherited from Visual) |
| InitialWorldLocation |
The InitialLocation of this Visual and all its Parent Visuals in Matrix form.
(Inherited from Visual) |
| InitialWorldMatrix |
The InitialLocation and InitialRotation of this Visual and all its Parent Visuals in Matrix form.
(Inherited from Visual) |
| IsActivated | Whether or not the stop blade is up (or moving to the up position). |
| IsFloorVisual |
Is this visual a floor visual.
(Inherited from MeshObject) |
| IsInDownPosition | Whether or not the stop blade is in the down position. |
| IsInTransit | Whether or not the stop blade is in transit to the up or down position. |
| IsInUpPosition | Whether or not the stop blade is in the up position. |
| IsSimulationTransferInProgress | (Inherited from Visual) |
| IsStatic |
Can this visual change its Location/Rotation relative to its parent at runtime.
This is used to improve simulation and graphical performance
by analyzing what can and can't move during a model run.
(Inherited from Visual) |
| IsVisible |
There is a mesh and the properties are set to visible.
(Inherited from MeshObject) |
| IsWorldStatic |
Whether this visual and all its ancestor visuals are Static.
(Inherited from Visual) |
| Kinematic | Move the stop blade kinematically instead of dynamically which means the stop blade will move with infinite force. |
| Layer | The layer for this object. If (As Parent) it inherits its layer from its parent, which may in turn inherit the layer from its parent, etc. (Inherited from Visual) |
| LiftDuration | How long the stop blade takes to go from the rest height to the lift height. |
| LiftHeight | The distance above the conveyor surface that the stop blade should raise to. |
| Location |
The visual's X, Y, and Z coordinates relative to its parent.
(Inherited from Visual) |
| LocationX |
The visual's X coordinate relative to its parent.
(Inherited from Visual) |
| LocationY |
The visual's Y coordinate relative to its parent.
(Inherited from Visual) |
| LocationZ |
The visual's Z coordinate relative to its parent.
(Inherited from Visual) |
| Mass | The mass of the stop blade. |
| Matrix |
The current matrix transform of the Visual local to its Parent Visual.
(Inherited from Visual) |
| MaxForce | The maximum force that can be used to accelerate the joint motor to the specified velocity. |
| MeshBoundingBox | (Inherited from MeshObject) |
| MeshBoundingSphere | (Inherited from MeshObject) |
| MoveToEventsEnabled | If True, then MoveTo, TurnTo will issue events that indicate when the visual has started accelerating, cruising, decelerating and has stopped.
<p>
When enabled, the events are issued as OnAnimatorEvent. <p>An example function that will handle these events is:
<pre>
function Box_OnAnimatorEvent( sender : Visual, args : AnimatorEventArgs )
{
switch (args.EventType) {
case AnimatorEventType.Accelerate:
print("Accelerating");
break;
case AnimatorEventType.Cruise:
print("Cruising");
break;
case AnimatorEventType.Decelerate:
print("Decelerating");
break;
case AnimatorEventType.Stop:
print("Stopped");
break;
}
}
</pre>
(Inherited from Visual) |
| Name |
The name of the Visual.
(Inherited from Visual) |
| NativeObject |
The native C# scripting class instance for this visual
(Inherited from Visual) |
| NativeTypeName | The namespace and class name to instantiate for this Visual, e.g. Demo3D.Components.Component (in this case Demo3D.Components.dll will be loaded to try to find the class) (Inherited from Visual) |
| NewNameExpr | The string used to format the new name of this component if it is copied or added to the project from a catalog. The variable name "ID" will generate a unique number for that type of component in the current project. (Inherited from Visual) |
| NextSibling |
The next sibling of this visual, or null if this visual has no siblings.
(Inherited from Visual) |
| OnAfterParentPropertyUpdated | Occurs after a property of the parent visual is updated. (Inherited from Visual) |
| OnAfterPropertyUpdated | Occurs after a property of the visual is updated. (Inherited from Visual) |
| OnAfterSubscribedPropertyUpdated | Occurs after a property of a visual that has this visual in its PropertyUpdatedSubscribers list is updated. (Inherited from Visual) |
| OnAnimatorCompleted | Occurs when an animator completes. (Inherited from Visual) |
| OnAnimatorEvent | Occurs when the visual starts to accelerate, cruise, decelerate and stop during a MoveTo or TurnTo command. Note that this event will only be issued if MoveToEventsEnabled is set to True. (Inherited from Visual) |
| OnAspectRenamed | Occurs after an aspect on the visual is renamed. (Inherited from Visual) |
| OnBeforeParentPropertyUpdated | Occurs before a property of the parent visual is updated. (Inherited from Visual) |
| OnBeforePropertyUpdated | Occurs before a property of the visual is updated. (Inherited from Visual) |
| OnBladeDown | Occurs when the stop blade reaches the rest height. |
| OnBladeUp | Occurs when the stop blade reaches the lift height. |
| OnChildAdded | Occurs when a child is parented to this visual after the reparenting has been performed. (Inherited from Visual) |
| OnChildRemoved | Occurs when a child is unparented from this visual after the reparenting has been performed. (Inherited from Visual) |
| OnClick | Occurs when the visual is clicked on in demonstration/navigation mode. (Inherited from Visual) |
| OnConnected | Occurs when this visual is connected to another visual (Inherited from Visual) |
| OnContact | Occurs when a load collides with the stop blade. To prevent the script being run multiple times as the load bounces against the stop blade, the OnContact event is suppressed until the stop blade's ResetContactLatch() method is called. |
| OnCustomPropertyCreated | Occurs after a new custom property is added to the visual. (Inherited from Visual) |
| OnCustomPropertyRenamed | Occurs after a custom property of the visual is renamed. (Inherited from Visual) |
| OnCustomPropertyUpdated | Occurs after a custom property of the visual is updated. (Inherited from Visual) |
| OnDisconnected | Occurs when this visual is disconnected from another visual (Inherited from Visual) |
| OnDragEnd | Occurs when a visual has finished being dragged to a new location. (Inherited from Visual) |
| OnDragStart | Occurs when a visual is about to be dragged to a new location. (Inherited from Visual) |
| OnExperimentFinished | Occurs at the end of each experiment. This allows finalization of any data collection, for example. (Inherited from Visual) |
| OnExperimentPreInitialize | Occurs at the before each experiment starts running but after the current experiment row variables have been set. This allows initialization of the model to be done before OnInitialize has been called. (Inherited from Visual) |
| OnExperimentStarted | Occurs at the start of each experiment. This allows for initialization of any data collection, for example. (Inherited from Visual) |
| OnExportBindableItem | Occurs when Export is called from the Tag Browser. This allows custom information to be written about each tag in addition to the default data. (Inherited from Visual) |
| OnInitialize | Occurs when Play is pressed at time 0. (Inherited from Visual) |
| OnKey | Occurs when a key is pressed or released and this visual is selected. (Inherited from Visual) |
| OnKeyPress | Occurs when a key is pressed and this visual is selected. (Inherited from Visual) |
| OnLoaded | Occurs when the document is loaded. (Inherited from Visual) |
| OnMessage | Occurs when a message is sent from another visual's MessageListeners list. (Inherited from Visual) |
| OnMouseLeave | Occurs when the mouse moves away from the visual. (Inherited from Visual) |
| OnMouseMove | Occurs when the mouse moves over the visual. (Inherited from Visual) |
| OnMouseOver | Occurs when the mouse enters the visual. (Inherited from Visual) |
| OnMouseUp | Occurs when a mouse button is released after being pressed on the visual. (Inherited from Visual) |
| OnMoved | Occurs when a visual has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit. (Inherited from Visual) |
| OnMoveToCompleted | Occurs when a MoveTo or TurnTo has finished. (Inherited from Visual) |
| OnNameChanged | Occurs when this visual's name is changed. (Inherited from Visual) |
| OnParentMoved | Occurs when a parent or parent's parent, etc. has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit. (Inherited from Visual) |
| OnParentUpdated | Occurs when the parent for the visual changes. (Inherited from Visual) |
| OnPreInitialize | Occurs before OnInitialize is called. The OnPreInitialize is called for every visual in one pass. Then a second pass calls OnInitialize for every visual. (Inherited from Visual) |
| OnRenderType | Occurs whenever the render status of a visual type is changed. This is usually in response to the user pressing one of the "Show X" buttons on the toolbar; for example, "Show Lights", "Show Support Stands", etc. (Inherited from Visual) |
| OnReset | Occurs when Reset is pressed. (Inherited from Visual) |
| OnShortcut | (Inherited from Visual) |
| OnShowDirections | Occurs when the status of the "Show Direction Arrows" configuration is changed. (Inherited from Visual) |
| OnUnloaded | Occurs when the document is unloaded (Inherited from Visual) |
| OnVisualAdded | Occurs when this visual is added to the model. The scene's "OnVisualAdded" is also called for each visual that is added. (Inherited from Visual) |
| OnVisualRemoved | Occurs when this visual is removed from the model. The scene's "OnVisualRemoved" script is also called whenever any visual is removed. (Inherited from Visual) |
| Parent |
The parent Visual for this Visual.
(Inherited from Visual) |
| PhysicsCollisionMargin |
The default collision margin for physics collision geometry belonging to the visual's
PhysicsBody.
(Inherited from Visual) |
| PhysicsEnabled |
Whether the physics for the visual is enabled or not.
(Inherited from Visual) |
| PropertyUpdatedSubscribers | Visuals that will be notified when any custom property on this visual is updated. Each visual will be notified via its "OnAfterSubscribedPropertyUpdated" script.
<p>
See also:
<ul>
<li>OnAfterSubscribedPropertyUpdated
</ul> (Inherited from Visual) |
| RestHeight | The distance below the conveyor surface that this should be when at rest. |
| RotationDegrees |
The rotation of the Visual (in degrees) relative to ts Parent Visual.
(Inherited from Visual) |
| RotationMatrix |
The rotation of this Visual relative to its Parent in Matrix form.
(Inherited from Visual) |
| RotationRadians |
The rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual) |
| RotationXDegrees |
The X rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual) |
| RotationXRadians |
The X rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual) |
| RotationYDegrees |
The Y rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual) |
| RotationYRadians |
The Y rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual) |
| RotationZDegrees |
The Z rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual) |
| RotationZRadians |
The Z rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual) |
| SelectParentWhenPicked | If this component is clicked on or is included in a selection rectangle then the parent is selected instead and its properties are shown instead. Once this is set the properties can only be changed from the Project Explorer Window. (Inherited from Visual) |
| SimpleProperties | Enter a non-empty name for each property that should be shown in the Simple Properties view. (Inherited from Visual) |
| SurfaceArea |
Surface area of shape - for certain shapes (e.g. box, sphere, cylinder) this is overridden and it is accurate
Otherwise it is the surface area of the triangular faces in the mesh. This requires a "closed" mesh, that the
mesh does not have both front and back faces, and any overlap in the mesh will be counted multiple times.
(Inherited from MeshObject) |
| SurfaceAreaDeep |
Surface area of Visual and all its children.
(Inherited from Visual) |
| Tags | List of names that can be used to provide multiple categories of components in a catalog. The catalog can show only components with tag "Pallets", for example. (Inherited from Visual) |
| TargetBladeState | The state the stop blade is aiming towards. |
| ToolTipExpr | The format string for the tooltip that appears for an object. (Inherited from Visual) |
| TopParent |
Get the top level visual, the one which has no parent.
(Inherited from Visual) |
| TransferState |
The current state of transfers in or out of this visual using the Transfer Protocol.
This is normally set for transfer enabled equipment (not loads).
(Inherited from Visual) |
| TransferStateEnabled |
Whether this visual supports the Transfer Protocol.
This is normally set for transfer enabled equipment (not loads).
(Inherited from Visual) |
| Type |
A type string for the Visual.
(Inherited from Visual) |
| UserData | A string that can be used to store any custom data about the visual. This is passed to the WebGL and VR renderers to be used in remote applications. (Inherited from Visual) |
| UserVars | A dictionary of user key value pairs that can be used to store any custom data about the visual. (Inherited from Visual) |
| Velocity |
The current linear velocity of the Visual in meters/second.
(Inherited from Visual) |
| VertexCount |
Number of vertices in the mesh
(Inherited from MeshObject) |
| VertexCountDeep |
Number of vertices in Mesh for Visual and all its children.
(Inherited from Visual) |
| Visible | Indicates if the built-in visual is drawn. If not visible, the component will still operate as normal, allowing it to be grouped with an imported graphic for custom component types. (Inherited from MeshObject) |
| VisibleFrom | The object becomes visible when it's center is this distance from the camera or greater. The default is 0. Useful for level of detail control. (Inherited from MeshObject) |
| VisibleTo | The object becomes invisible when it's center is this distance from the camera or greater. The default is Infinity. Useful for level of detail control, such as hiding small objects like bolts when they get far from the camera. (Inherited from MeshObject) |
| VisualAndAncestors |
Return all ancestor visuals above this point in the Visual hierarchy, including the Visual itself.
(Inherited from Visual) |
| VisualAndDescendants |
Return all visuals below this point in the Visual hierarchy including the Visual itself.
(Inherited from Visual) |
| Volume |
Volume of material in shape - for certain shapes (e.g. box, sphere, cylinder) this is overridden and it is accurate
Otherwise it is the volume enclosed by the triangular faces in the mesh. This requires a "closed" mesh, that the
mesh does not have both front and back faces, and any overlap in the mesh will be counted multiple times.
(Inherited from MeshObject) |
| VolumeDeep |
Volume of Visual and all its children.
(Inherited from Visual) |
| Width | The width of the stop blade. |
| WidthRatio | The ratio of the conveyor width, that the stop blade is attached to, to set the stop blade width to. |
| WorldBoundingBox |
The world axis aligned bounding box of this Visual
including the bounding boxes of all the child visuals and their children.
(Inherited from Visual) |
| WorldBoundingBoxExcludingChildren |
The world axis aligned bounding box of this Visual only (excluding any children).
(Inherited from Visual) |
| WorldBoundingSphere |
Get the bounding sphere of this visual, including its children, in world space relative to the Scene.
(Inherited from Visual) |
| WorldBoundingSphereExcludingChildren |
Get the bounding sphere of this visual, excluding its children, in world space relative to the Scene.
(Inherited from Visual) |
| WorldLocation |
The visual's world X, Y, and Z coordinates relative to the Scene.
(Inherited from Visual) |
| WorldLocationX |
The visual's world X coordinate relative to the Scene.
(Inherited from Visual) |
| WorldLocationY |
The visual's world Y coordinate relative to the Scene.
(Inherited from Visual) |
| WorldLocationZ |
The visual's world Z coordinate relative to the Scene.
(Inherited from Visual) |
| WorldMatrix |
The Location and Rotation of this Visual in Matrix form.
(Inherited from Visual) |
| WorldMinimumY | (Inherited from MeshObject) |
| WorldRotationDegrees |
The world rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual) |
| WorldRotationMatrix |
The rotation of this Visual relative to the Scene in Matrix form.
(Inherited from Visual) |
| WorldRotationRadians |
The world rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual) |
| WorldRotationXDegrees |
The world X rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual) |
| WorldRotationXRadians |
The world X rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual) |
| WorldRotationYDegrees |
The world Y rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual) |
| WorldRotationYRadians |
The world Y rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual) |
| WorldRotationZDegrees |
The world Z rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual) |
| WorldRotationZRadians |
The world Z rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual) |
| WorldXAxis |
The world X-Axis for the visual
(Inherited from Visual) |
| WorldYAxis |
The world Y-Axis for the visual
(Inherited from Visual) |
| WorldZAxis |
The world Z-Axis for the visual
(Inherited from Visual) |
See Also