Click or drag to resize

ShelfVisual Class

Class to manage the state of an area for storing loads. This can be a shelf in a rack or an area on a floor.
Inheritance Hierarchy
SystemObject
  System.DynamicDynamicObject
    NotifyPropertyChangedBase
      Demo3D.VisualsVisual
        Demo3D.VisualsMeshObject
          Demo3D.VisualsShelfVisual

Namespace:  Demo3D.Visuals
Assembly:  Demo3D.Core (in Demo3D.Core.dll) Version: 10.0.0.6737
Syntax
C#
public class ShelfVisual : MeshObject

The ShelfVisual type exposes the following members.

Properties
  NameDescription
Public propertyAllConnectors
Gets all connectors.
(Inherited from Visual.)
Public propertyAllowWaitOnMove

Field Value

Type: 
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.)
Public propertyAngularVelocity
The current angular velocity of the Visual in radians/second.
(Inherited from Visual.)
Public propertyAnimatorInProgress
Determine if any animations are currently in progress for this Visual.
(Inherited from Visual.)
Public propertyApp
The global application object.
(Inherited from Visual.)
Public propertyBayDepth

Field Value

Type: 
The depth of each bay.
Public propertyBayGap

Field Value

Type: 
The gap before each bay and after the last bay.
Public propertyBayModule

Field Value

Type: 
The current center module for the bay, e.g. empty, (chip)board, roller, etc.
Public propertyBayWidth

Field Value

Type: 
The width of each individual bay.
Public propertyBeamDepth

Field Value

Type: 
The depth of the supporting beam going into the bay.
Public propertyBeamHeight

Field Value

Type: 
The height of the supporting beam go down from the top of the bay.
Public propertyBeamMaterial

Field Value

Type: 
The color of the supporting beam.
Public propertyBeamStep

Field Value

Type: 
The height of the beam above the top (positive) or below the top (negative) of the bay floor. 0 is no step and the top of the beam lines up with the base of the bay floor.
Public propertyBeamVisible

Field Value

Type: 
Whether the bay supporting beams are visible.
Public propertyBillboard

Field Value

Type: 
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.)
Public propertyBillOfMaterialsCodeExpr

Field Value

Type: 
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.)
Public propertyBillOfMaterialsCostExpr

Field Value

Type: 
The cost of the component as it appears in the bill of materials, e.g. "1595.95".
(Inherited from Visual.)
Public propertyBillOfMaterialsDescriptionExpr

Field Value

Type: 
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.)
Public propertyBins

Field Value

Type: 
Details of the available bins for each bay along the shelf.
Public propertyBoundingBox
Get the bounding box of this visual including all its children.
(Inherited from Visual.)
Public propertyBoundingBoxExcludingChildren (Inherited from MeshObject.)
Public propertyBoundingSphere
Get the bounding sphere of this visual, including its children.
(Inherited from Visual.)
Public propertyBoundingSphereExcludingChildren (Inherited from MeshObject.)
Public propertyCapacity

Field Value

Type: 
The number of loads that can be stored on the shelf.
Public propertyCastsShadow

Field Value

Type: 
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.)
Public propertyChildren
Return the collection of child Visuals.
(Inherited from Visual.)
Public propertyColor
The diffuse color of the first mesh material on the mesh object.
(Inherited from MeshObject.)
Public propertyColors
The diffuse colors of the all the mesh materials on the mesh object.
(Inherited from MeshObject.)
Public propertyConnectAllowed

Field Value

Type: 
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.)
Public propertyConnectDisallowed

Field Value

Type: 
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.)
Public propertyConnectorPairs
All pairs of connectors from this visual.
(Inherited from Visual.)
Public propertyControlPointsAllowed

Field Value

Type: 
A white list of control points that should be shown and editable.
(Inherited from Visual.)
Public propertyControlPointsDisallowed

Field Value

Type: 
A black list of control points that should be hidden and not editable.
(Inherited from Visual.)
Public propertyCSGOperations
(Inherited from MeshObject.)
Public propertyCurrentRoutingTarget
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.)
Public propertyCurrentStation
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.)
Public propertyCurrentTransfer
Information about the current transfer in progress for this visual using the Transfer Protocol. This is normally set for loads.
(Inherited from Visual.)
Public propertyCustomProperties
The collection of CustomProperty objects for this Visual.
(Inherited from Visual.)
Public propertyDelayDur

Field Value

Type: 
The time in seconds to delay the creation of the next load once the number of loads created has hit the Delay Interval.
Public propertyDelayDurVariability

Field Value

Type: 
A random adjustment to the load creation delay time once a delay has occurred (Delay Duration +/- this value).
Public propertyDelayRate

Field Value

Type: 
Add a delay to the release of the next load after this number of loads have been created.
Public propertyDelayRateVariability

Field Value

Type: 
A random adjustment to the number of loads to be created before there is a delay (Delay Interval +/- this value).
Public propertyDeleteLoadsWhenFloorHit

Field Value

Type: 
If this is true and load created touches the floor at any time it will be deleted after the number of seconds defined by the 'Delete Loads After' setting for the project. If this is false then the load specific setting will be used.
Public propertyDescendants
Return all visuals below this point in the Visual hierarchy .
(Inherited from Visual.)
Public propertyDescendantsDepthFirst
Return all visuals below this point in the Visual hierarchy .
(Inherited from Visual.)
Public propertyDescription
A description of the Visual.
(Inherited from Visual.)
Public propertyDocument
The document that this Visual belongs to.
(Inherited from Visual.)
Public propertyDraggable
Whether the visual be dragged using the mouse.
(Inherited from Visual.)
Public propertyFaceCount
Number of triangular faces in the mesh
(Inherited from MeshObject.)
Public propertyFaceCountDeep
Number of faces in Mesh for Visual and all its children.
(Inherited from Visual.)
Public propertyFirstChild
The first child visual of this visual, or null if this visual has no children.
(Inherited from Visual.)
Public propertyFirstLoadAfter

Field Value

Type: 
Wait this number of seconds before the first load is created.
Public propertyFixToParent

Field Value

Type: 
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.)
Public propertyFullName
The full name of this Visual, including the names of all Parent Visual separated by '.' characters.
(Inherited from Visual.)
Public propertyHasChildren
Determine if this Visual has any children or not.
(Inherited from Visual.)
Public propertyHasNextSibling
Determine if this Visual has any siblings or not.
(Inherited from Visual.)
Public propertyHeight

Field Value

Type: 
The height of the shelf relative to its parent object.
Public propertyHideAdvancedProperties
(Inherited from Visual.)
Public propertyId
A unique identifier for this Visual.
(Inherited from Visual.)
Public propertyIncludeChildContextMenus

Field Value

Type: 
When right clicking on the object should child objects menu items be included. Default is false.
(Inherited from Visual.)
Public propertyInDelay

Field Value

Type: 
Indicates that the load creator is currently in a delay period. See DelayDur and DelayRate properties.
Public propertyInitialLocation
The InitialLocation of the Visual in meters from the Origin of the Parent Visual.
(Inherited from Visual.)
Public propertyInitialMatrix
The InitialLocation and InitialRotation in Matrix form.
(Inherited from Visual.)
Public propertyInitialParentOnReset

Field Value

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

Field Value

Type: 
Moves the visual back to its initial location and rotation when Reset is pressed.
(Inherited from Visual.)
Public propertyInitialQuantity

Field Value

Type: 
Populate the shelf with this number of loads initially.
Public propertyInitialRotationDegrees
The InitialRotation of the Visual in degrees relative to the Rotation of Parent Visual.
(Inherited from Visual.)
Public propertyInitialRotationMatrix
The InitialRotation in Matrix form.
(Inherited from Visual.)
Public propertyInitialRotationRadians
The InitialRotation of the Visual in radians relative to the Rotation of Parent Visual.
(Inherited from Visual.)
Public propertyInitialWorldLocation
The InitialLocation of this Visual and all its Parent Visuals in Matrix form.
(Inherited from Visual.)
Public propertyInitialWorldMatrix
The InitialLocation and InitialRotation of this Visual and all its Parent Visuals in Matrix form.
(Inherited from Visual.)
Public propertyIsFloorVisual
Is this visual a floor visual.
(Inherited from MeshObject.)
Public propertyIsVisible
There is a mesh and the properties are set to visible.
(Inherited from MeshObject.)
Public propertyItemsVisual

Field Value

Type: 
Undocumented
Public propertyLayer

Field Value

Type: 
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.)
Public propertyLocation
The visual's X, Y, and Z coordinates relative to its parent.
(Inherited from Visual.)
Public propertyLocationX
The visual's X coordinate relative to its parent.
(Inherited from Visual.)
Public propertyLocationY
The visual's Y coordinate relative to its parent.
(Inherited from Visual.)
Public propertyLocationZ
The visual's Z coordinate relative to its parent.
(Inherited from Visual.)
Public propertyMatrix
The current matrix transform of the Visual local to its Parent Visual.
(Inherited from Visual.)
Public propertyMeshBoundingBox (Inherited from MeshObject.)
Public propertyMeshBoundingSphere (Inherited from MeshObject.)
Public propertyMoveToEventsEnabled

Field Value

Type: 
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.)
Public propertyName
The name of the Visual.
(Inherited from Visual.)
Public propertyNativeObject
The native C# scripting class instance for this visual
(Inherited from Visual.)
Public propertyNativeTypeName

Field Value

Type: 
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.)
Public propertyNewNameExpr

Field Value

Type: 
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.)
Public propertyNextSibling
The next sibling of this visual, or null if this visual has no siblings.
(Inherited from Visual.)
Public propertyNumBays

Field Value

Type: 
The number of bays along the length of the shelf.
Public propertyOnAfterParentPropertyUpdated
(Inherited from Visual.)
Public propertyOnAfterPropertyUpdated
(Inherited from Visual.)
Public propertyOnAfterSubscribedPropertyUpdated
(Inherited from Visual.)
Public propertyOnAllowStoreInBin

Field Value

Type: 
An event called to determine if a load should be stored in a given bin or not. This allows zones to be setup in a shelf based on load type.
Public propertyOnAnimatorCompleted

Field Value

Type: 
Undocumented
(Inherited from Visual.)
Public propertyOnAnimatorEvent

Field Value

Type: 
Call this script 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. <p> See also: <ul> <li>MoveToEventsEnabled </ul>
(Inherited from Visual.)
Public propertyOnBeforeParentPropertyUpdated
(Inherited from Visual.)
Public propertyOnBeforePropertyUpdated
(Inherited from Visual.)
Public propertyOnChildAdded

Field Value

Type: 
Call this script when a child is parented to this visual after the reparenting has been performed.
(Inherited from Visual.)
Public propertyOnChildRemoved

Field Value

Type: 
Call this script when a child is unparented from this visual after the reparenting has been performed.
(Inherited from Visual.)
Public propertyOnClick

Field Value

Type: 
Call this script when the visual is clicked on in demonstration/navigation mode.
(Inherited from Visual.)
Public propertyOnConnected

Field Value

Type: 
Call this script whenever this visual is connected to another visual
(Inherited from Visual.)
Public propertyOnCustomPropertyUpdated
(Inherited from Visual.)
Public propertyOnDelayEnd

Field Value

Type: 
The script function to run when the delay period ends.
Public propertyOnDelayStart

Field Value

Type: 
The script function to run when the delay period starts.
Public propertyOnDisconnected

Field Value

Type: 
Call this script when this visual is disconnected from another visual
(Inherited from Visual.)
Public propertyOnDragEnd

Field Value

Type: 
Call this script when a visual has finished being dragged to a new location.
(Inherited from Visual.)
Public propertyOnDragStart

Field Value

Type: 
Call this script when a visual is about to be dragged to a new location.
(Inherited from Visual.)
Public propertyOnExperimentFinished

Field Value

Type: 
Call this script at the end of each experiment. This allows finalization of any data collection, for example. <p> See also: <ul> <li>OnExperimentStarted</li> </ul>
(Inherited from Visual.)
Public propertyOnExperimentStarted

Field Value

Type: 
Call this script at the start of each experiment. This allows for initialization of any data collection, for example. <p> See also: <ul> <li>OnExperimentFinished</li> </ul>
(Inherited from Visual.)
Public propertyOnExportBindableItem

Field Value

Type: 
Undocumented
(Inherited from Visual.)
Public propertyOnInitialize

Field Value

Type: 
The script to run when Play is pressed at time 0.
(Inherited from Visual.)
Public propertyOnKey

Field Value

Type: 
Call this script when a key is pressed and this visual is selected.
(Inherited from Visual.)
Public propertyOnLoadAdded

Field Value

Type: 
Call this script when a load is added to the shelf.
Public propertyOnLoadCreated

Field Value

Type: 
Script to be executed when a load is created
Public propertyOnLoaded

Field Value

Type: 
Undocumented
(Inherited from Visual.)
Public propertyOnLoadRemoved

Field Value

Type: 
Call this script when a load is removed from the shelf.
Public propertyOnMessage

Field Value

Type: 
Call this script when a message is received from another visual. <p> To receive messages, this visual must be included in the other visual's MessageListeners list. <p> See also: <ul> <li>MessageListenersEnabled</li> </ul>
(Inherited from Visual.)
Public propertyOnMouseLeave

Field Value

Type: 
Undocumented
(Inherited from Visual.)
Public propertyOnMouseOver

Field Value

Type: 
Undocumented
(Inherited from Visual.)
Public propertyOnMouseUp

Field Value

Type: 
Undocumented
(Inherited from Visual.)
Public propertyOnMoved

Field Value

Type: 
Call this script when a visual has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit.
(Inherited from Visual.)
Public propertyOnMoveToCompleted

Field Value

Type: 
Call this script when a MoveTo or TurnTo has finished.
(Inherited from Visual.)
Public propertyOnParentMoved

Field Value

Type: 
Call this script 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.)
Public propertyOnParentUpdated

Field Value

Type: 
Undocumented
(Inherited from Visual.)
Public propertyOnPreInitialize
(Inherited from Visual.)
Public propertyOnRenderType

Field Value

Type: 
Call this script 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.)
Public propertyOnReset

Field Value

Type: 
The script to be run when Reset is pressed.
(Inherited from Visual.)
Public propertyOnShowDirections

Field Value

Type: 
Call this script when the status of the "Show Direction Arrows" configuration is changed.
(Inherited from Visual.)
Public propertyOnUnloaded

Field Value

Type: 
Undocumented
(Inherited from Visual.)
Public propertyOnVisualAdded

Field Value

Type: 
Call this script when this visual is added to the model. The scene's "OnVisualAdded" is also called for each visual that is added.
(Inherited from Visual.)
Public propertyOnVisualRemoved

Field Value

Type: 
Call this script when this visual is removed from the model. The scene's "OnVisualRemoved" script is also called whenever any visual is removed.
(Inherited from Visual.)
Public propertyOverallLength

Field Value

Type: 
The total length of the shelf (NumBays*BayWidth + (NumBays+1)*BayGap).
Public propertyParent
The parent Visual for this Visual.
(Inherited from Visual.)
Public propertyPhysicsEnabled
Whether the physics for the visual is enabled or not.
(Inherited from Visual.)
Public propertyPropertyUpdatedSubscribers

Field Value

Type: 
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.)
Public propertyReleaseEnabled

Field Value

Type: 
If true then new loads will be created. If false then no loads will be created.
Public propertyReleaseRate

Field Value

Type: 
The number of seconds between the creation of each load.
Public propertyReleaseRateVariability

Field Value

Type: 
A random adjustment to the release time to the next load (Release Interval +/- this value).
Public propertyReleaseStrategy

Field Value

Type: 
If Sequence then loads will be created in the sequence defined in the Loads list. If Distribution then loads will be picked at random from the loads list and created in a random order using a uniform distribution.
Public propertyRetryCreateAfter

Field Value

Type: 
If a load can't be created for whatever reason then wait for this number of seconds and then try to recreate the load again.
Public propertyRotationDegrees
The rotation of the Visual (in degrees) relative to ts Parent Visual.
(Inherited from Visual.)
Public propertyRotationMatrix
The rotation of this Visual relative to its Parent in Matrix form.
(Inherited from Visual.)
Public propertyRotationRadians
The rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual.)
Public propertyRotationVariability

Field Value

Type: 
A random adjustment to the rotation angle that a load is created with.
Public propertyRotationXDegrees
The X rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual.)
Public propertyRotationXRadians
The X rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual.)
Public propertyRotationYDegrees
The Y rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual.)
Public propertyRotationYRadians
The Y rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual.)
Public propertyRotationZDegrees
The Z rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual.)
Public propertyRotationZRadians
The Z rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual.)
Public propertySelectParentWhenPicked

Field Value

Type: 
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.)
Public propertySequenceNumber

Field Value

Type: 
The sequence number of the next load to be created. The sequence number of first load to be created is 0.
Public propertyShelfDetail

Field Value

Type: 
The detail to show for the shelf. FrontOnly or BackOnly will show an indicator of what the shelf looks like at the front or back of the shelf only. Whole shelf will draw the all bays as one long bay. Individual bays will draw each bay individually which may have a performance impact for large systems.
Public propertySimpleProperties

Field Value

Type: 
Enter a non-empty name for each property that should be shown in the Simple Properties view.
(Inherited from Visual.)
Public propertySurfaceArea
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.)
Public propertySurfaceAreaDeep
Surface area of Visual and all its children.
(Inherited from Visual.)
Public propertyTags

Field Value

Type: 
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.)
Public propertyToolTipExpr

Field Value

Type: 
The format string for the tooltip that appears for an object.
(Inherited from Visual.)
Public propertyTopParent
Get the top level visual, the one which has no parent.
(Inherited from Visual.)
Public propertyTransferState
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.)
Public propertyTransferStateEnabled
Whether this visual supports the Transfer Protocol. This is normally set for transfer enabled equipment (not loads).
(Inherited from Visual.)
Public propertyType
A type string for the Visual.
(Inherited from Visual.)
Public propertyUserData
(Inherited from Visual.)
Public propertyUserVars
(Inherited from Visual.)
Public propertyVelocity
The current linear velocity of the Visual in meters/second.
(Inherited from Visual.)
Public propertyVertexCount
Number of vertices in the mesh
(Inherited from MeshObject.)
Public propertyVertexCountDeep
Number of vertices in Mesh for Visual and all its children.
(Inherited from Visual.)
Public propertyVisible

Field Value

Type: 
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.)
Public propertyVisibleFrom

Field Value

Type: 
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.)
Public propertyVisibleTo

Field Value

Type: 
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.)
Public propertyVolume
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.)
Public propertyVolumeDeep
Volume of Visual and all its children.
(Inherited from Visual.)
Public propertyWorldBoundingBox
The world axis aligned bounding box of this Visual including the bounding boxes of all the child visuals and their children.
(Inherited from Visual.)
Public propertyWorldBoundingBoxExcludingChildren
The world axis aligned bounding box of this Visual only (excluding any children).
(Inherited from Visual.)
Public propertyWorldBoundingSphere
Get the bounding sphere of this visual, including its children, in world space relative to the Scene.
(Inherited from Visual.)
Public propertyWorldBoundingSphereExcludingChildren
Get the bounding sphere of this visual, excluding its children, in world space relative to the Scene.
(Inherited from Visual.)
Public propertyWorldHeight

Field Value

Type: 
The height of the front corner of the shelf relative to the floor of the scene.
Public propertyWorldLocation
The visual's world X, Y, and Z coordinates relative to the Scene.
(Inherited from Visual.)
Public propertyWorldLocationX
The visual's world X coordinate relative to the Scene.
(Inherited from Visual.)
Public propertyWorldLocationY
The visual's world Y coordinate relative to the Scene.
(Inherited from Visual.)
Public propertyWorldLocationZ
The visual's world Z coordinate relative to the Scene.
(Inherited from Visual.)
Public propertyWorldMatrix
The Location and Rotation of this Visual in Matrix form.
(Inherited from Visual.)
Public propertyWorldMinimumY (Inherited from MeshObject.)
Public propertyWorldRotationDegrees
The world rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual.)
Public propertyWorldRotationMatrix
The rotation of this Visual relative to the Scene in Matrix form.
(Inherited from Visual.)
Public propertyWorldRotationRadians
The world rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual.)
Public propertyWorldRotationXDegrees
The world X rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual.)
Public propertyWorldRotationXRadians
The world X rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual.)
Public propertyWorldRotationYDegrees
The world Y rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual.)
Public propertyWorldRotationYRadians
The world Y rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual.)
Public propertyWorldRotationZDegrees
The world Z rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual.)
Public propertyWorldRotationZRadians
The world Z rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual.)
Public propertyWorldXAxis
The world X-Axis for the visual
(Inherited from Visual.)
Public propertyWorldYAxis
The world Y-Axis for the visual
(Inherited from Visual.)
Public propertyWorldZAxis
The world Z-Axis for the visual
(Inherited from Visual.)
Top
Methods
  NameDescription
Public methodCode exampleAddCustomProperty(String, Object, String)
Add a custom property to the visual. If the custom property already exists, then this call will update its value and description.
(Inherited from Visual.)
Public methodCode exampleAddCustomProperty(String, Type, Object, String)
Add a custom property to the visual. If the custom property already exists, then this call will update its value, type and description. <p> <strong>Note</strong>: For most uses, <code>AddCustomProperty(name,value,description)</code> or <code>AddSimpleProperty(name,value,description)</code> is more suitable, because there is no need to pass the type parameter; it is taken automatically from the value.
(Inherited from Visual.)
Public methodAddLocationProperty
Public methodAddSimpleProperty(String, Object, String)
Add a custom property and also add a PropertyAlias for that new customer property making it appear as a Simple Property.
(Inherited from Visual.)
Public methodAddSimpleProperty(String, Type, Object, String)
Add a custom property and also add a PropertyAlias for that new customer property making it appear as a Simple Property.
(Inherited from Visual.)
Public methodAddTemporaryProperty(String, Object)
Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.
(Inherited from Visual.)
Public methodAddTemporaryProperty(String, Object, String)
Create a temporary custom property that won't persistent on disk when saved.
(Inherited from Visual.)
Public methodAddTemporaryProperty(String, Type, Object)
Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.
(Inherited from Visual.)
Public methodAddTemporaryProperty(String, Type, Object, String)
Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.
(Inherited from Visual.)
Public methodCode exampleAlignToFloor
Align the mesh bounding box of the Visual to the default FloorVisual of the Scene.
(Inherited from Visual.)
Public methodCode exampleAlignToFloor(Visual)
Align the mesh bounding box of the Visual to the specified FloorVisual. Pass 'null' or the SceneVisual to align to the default FloorVisual of the Scene.
(Inherited from Visual.)
Public methodAllocateBinLocation
Public methodAssignToLocation
Public methodBayLeftX
Returns the X location of the start/left of the nth bay.
Public methodBinLeftX
Returns the X location of the center of the nth bay.
Public methodBinProps
Returns the properties for a given bin location. This could be used to override the properties for a given bin.
Public methodBinSpacing
The space between each bin and also between the start and end bins and the edge These 3 bins (gaps) have 4*bin spaces (spokes): |--bin1--|--bin2--|-----bin3-----| NOTE: bin is currently ignored but is required in case bin overrides are added in the future.
Public methodBinWidth
The width a of given bin. NOTE: bin is currently ignored but is required in case bin overrides are added in the future.
Public methodCancelAnimators
Cancel any animations that are currently in progress.
(Inherited from Visual.)
Public methodChildrenAsList
Return a List<Visual> representing all the children of this visual
(Inherited from Visual.)
Public methodCode exampleClone
Create a copy of a visual and its children placed in the top level scene.
(Inherited from Visual.)
Public methodConnectedVisual
Find the visual that is attached to the supplied connectorName.
(Inherited from Visual.)
Public methodCode exampleConnectTo(String, Visual, String)
Connect the visual to another visual with the corresponding connector names. This connection replaces any existing connections on this or the other visual's connector.
(Inherited from Visual.)
Public methodCode exampleConnectTo(String, Visual, String, Boolean)
Connect the visual to another visual with the corresponding connector names. This connection replaces any existing connections on this or the other visual's connector, unless allowMultiple is true, in which case this connection is added to existing connections.
(Inherited from Visual.)
Public methodContains
Is the visual contained by the visual tree from this point down?
(Inherited from Visual.)
Public methodContainsChild
Is the child a direct child of the visual.
(Inherited from Visual.)
Public methodCreateLoadNow
Public methodCreateLoadVisual
Public methodCustomPropertyDefined
Determine whether a given custom property name is defined.
(Inherited from Visual.)
Public methodStatic memberDefaultFactory
Public methodDelete
Delete this visual. If it is in a Document, it is removed from the document as well.
(Inherited from Visual.)
Public methodCode exampleDisconnect
Disconnect any connections on the supplied connector name.
(Inherited from Visual.)
Public methodCode exampleFadeToColor
Changes the color over a given time. This method blocks the current script until the transition is complete.
(Inherited from MeshObject.)
Public methodFadeToColorDeep
Animate the primary color of a visual and all its descendants in a given time.
(Inherited from Visual.)
Public methodFadeToMultipleColors
Changes the set of material colors over a given time. This method blocks the current script until the transition is complete.
(Inherited from MeshObject.)
Public methodCode exampleFadeToTransparency
Change the transparency over a given time period. Note that this may have no effect if the visual has a texture in its material.
(Inherited from MeshObject.)
Public methodFadeToTransparencyDeep
Animate the transparency of a visual and all its descendants in a given time.
(Inherited from Visual.)
Public methodFilteredChildren
Return the collection of child Visuals that match the given predicate.
(Inherited from Visual.)
Public methodFilteredDescendants
Return all visuals below this point in the Visual hierarchy that match the given predicate.
(Inherited from Visual.)
Public methodFindChild
Look through children and their children to find the first visual of a given name. Breadth first search.
(Inherited from Visual.)
Public methodFindConnector
Find a named connector on a conveyor object, e.g. "Start"
(Inherited from Visual.)
Public methodFindCreateConnector
Find or create a connector of the supplied name.
(Inherited from Visual.)
Public methodFindCustomProperty
Find a custom property by name if it exists. Otherwise return null.
(Inherited from Visual.)
Public methodFindDotNetType (Inherited from Visual.)
Public methodFindFirstOfType
Like FindType except it return the first instance of that type.
(Inherited from Visual.)
Public methodFindImmediateChild
Look through children to find a named visual.
(Inherited from Visual.)
Public methodFindImmediateChildren
Look through children to find all immediate children with a given name.
(Inherited from Visual.)
Public methodFindImmediateType(Type)
Find all the objects in the Children of type Type (immediate children only)
(Inherited from Visual.)
Public methodFindImmediateType(Type, IList)
Find all the objects in the Children of type Type (immediate children only)
(Inherited from Visual.)
Public methodFindParent(Type)
Go back up through the parents of visuals to find a particular parent type.
(Inherited from Visual.)
Public methodFindParent(PredicateVisual)
Go back up through the parents of visuals to find a particular parent that matches the supplied predicate.
(Inherited from Visual.)
Public methodFindType(Type)
Find all the objects in the Descendants of type Type (all descendants)
(Inherited from Visual.)
Public methodFindType(Type, IList)
Find all the objects in the Descendants of type Type (all descendants)
(Inherited from Visual.)
Public methodFindVisualType
Find all the visuals that have their Type field set to 'type'.
(Inherited from Visual.)
Public methodFirstBin
Get the first bin in the order specified in Props.ShelfOrder.
Public methodFreeze
Hold the load in one position by making it kinematic.
(Inherited from Visual.)
Public methodGetBinStates
Public methodGetCustomProperty
Get the container class for a custom property, or null if it doesn't exist.
(Inherited from Visual.)
Public methodGetCustomPropertyValue(String)
Get the value of a custom property, or null if it doesn't exist.
(Inherited from Visual.)
Public methodGetCustomPropertyValueT(String, T)
Get the value of a custom property, or a defaultValue if it doesn't exist.
(Inherited from Visual.)
Public methodGetLocationPropertyValue
Public methodGetNextRetrievableLoad
Returns the next load within a shelf.
Public methodGetNextRetrievableLoad(BinLocation)
Returns the next load within a bin.
Public methodGetNextRetrievalBinLocation
Returns the next load within a shelf.
Public methodGetNextStorageBinLocation
Public methodGetNextStoragePosition
Public methodGetNextStoragePosition(BinLocation)
Returns the position of the center of a the next available location within a bin location on the shelf in local coordinates. This takes into account the current loading to work out the height the next load should be placed at.
Public methodGoToInitialPosition
Set the Location and Rotation of the Visual to be the same as the InitialLocation and InitialRotation.
(Inherited from Visual.)
Public methodGoToInitialRotation
Set the Rotation of the Visual to be the same as the InitialRotation. The Location remains unchanged.
(Inherited from Visual.)
Public methodCode exampleHasCustomProperty
Determines whether a custom property has been defined or not.
(Inherited from Visual.)
Public methodHitTest
Public methodIsAncestorOf
Is this Visual a parent, grandparent, great grandparent etc. of the potentialChild.
(Inherited from Visual.)
Public methodIsDeleted
Determine if the Visual been deleted.
(Inherited from Visual.)
Public methodMoveToInitialPosition
Move to the InitialPosition and InitialRotation.
(Inherited from Visual.)
Public methodNextBin
Get the next bin in the order specified in Props.ShelfOrder.
Public methodNotifyOnMouseUp (Inherited from Visual.)
Public methodPopRoutingTarget
Pop a routing target from the current routing target stack, making the next target down the stack the new current routing target. Remove this visual from the previous target's custom property called "RoutingTargetAllocators".
(Inherited from Visual.)
Public methodPopulateRack
Public methodPrepareToRetrieve
Public methodPushRoutingTarget
Push a new routing target onto the stack of routing targets, making this the new current routing target. Add this visual to a custom property on the target called "RoutingTargetAllocators". This is normally called for loads.
(Inherited from Visual.)
Public methodRemoveAspectT (Inherited from Visual.)
Public methodRemoveConnector
Remove a connector with a certain name.
(Inherited from Visual.)
Public methodRemoveCustomProperty
Remove a custom property from the Visual.
(Inherited from Visual.)
Public methodRemoveLocationProperty
Public methodRotate(Axis, SpeedProfile) (Inherited from Visual.)
Public methodRotate(Axis, Double) (Inherited from Visual.)
Public methodRotate(Axis, Double, Double) (Inherited from Visual.)
Public methodRotate(Visual, Axis, SpeedProfile) (Inherited from Visual.)
Public methodRotate(Visual, Axis, SpeedProfile, RotationDirection) (Inherited from Visual.)
Public methodRotateByImmediate (Inherited from Visual.)
Public methodRotateToImmediate (Inherited from Visual.)
Public methodRotateToLocalX (Inherited from Visual.)
Public methodRotateToLocalY (Inherited from Visual.)
Public methodRotateToLocalZ (Inherited from Visual.)
Public methodSetCustomPropertyValueT
Set the value of a custom property or do nothing if it doesn't exist.
(Inherited from Visual.)
Public methodSetInitialPosition
Set InitialLocation to be the current Location and InitialRotation to be the current Rotation.
(Inherited from Visual.)
Public methodCode exampleSetNativeObject
Set the native C# scripting class instance for this visual
(Inherited from Visual.)
Public methodSetScriptNativeTypeName
Atomically set the Script and NativeTypeName together but only create the NativeObject once.
(Inherited from Visual.)
Public methodSimulateLoad
Indicates that this Visual should now be in control of simulating the supplied load.
(Inherited from Visual.)
Public methodSortChildrenAscendingT (Inherited from Visual.)
Public methodSortChildrenAscendingDeepT (Inherited from Visual.)
Public methodStick
Reparents this visual to a specified parents and disables physics. This is intended for use with loads, where parent is generally a vehicle or some visual that will be moving the load.
(Inherited from Visual.)
Public methodStickKinematic
Reparents this visual to a specified parents and sets visual to be kinematic This is intended for use with loads, where parent is generally a vehicle or some visual that will be moving the load.
(Inherited from Visual.)
Public methodToXml
Convert a visual to XML. Use Document.CreateVisual to turn it back into a copy of the original visual.
(Inherited from Visual.)
Public methodTransformFromWorld
Transform a world coordinate to a local coordinate
(Inherited from Visual.)
Public methodTransformFromWorldNormal
Transform a world normal to a local normal
(Inherited from Visual.)
Public methodTransformFromWorldRotationDegrees
Transform a world rotation (in degrees) to a local rotation (in degrees).
(Inherited from Visual.)
Public methodTransformFromWorldRotationRadians
Transform a world rotation (in radians) to a local rotation (in radians).
(Inherited from Visual.)
Public methodTransformToParent
Transform a local coordinate to coordinate local to parent.
(Inherited from Visual.)
Public methodTransformToParentNormal
Transform a local normal to normal local to parent
(Inherited from Visual.)
Public methodTransformToWorld
Transform a local coordinate to a world coordinate.
(Inherited from Visual.)
Public methodTransformToWorldNormal
Transform a local normal to a world normal.
(Inherited from Visual.)
Public methodTransformToWorldRotationDegrees
Transform a local rotation (in radians) to a world rotation (in radians).
(Inherited from Visual.)
Public methodTransformToWorldRotationRadians
Transform a local rotation (in radians) to a world rotation (in radians).
(Inherited from Visual.)
Public methodTranslateLocalX(Double)
Instantly move the visual along its local X axis by xOffset units
(Inherited from Visual.)
Public methodTranslateLocalX(Double, Double)
Move the visual along its local X axis by xOffset units, at the given speed.
(Inherited from Visual.)
Public methodTranslateLocalX(Double, Double, Double, Double)
Move the visual along its local X axis by xOffset units, at the given speed and acceleration
(Inherited from Visual.)
Public methodTranslateLocalY(Double)
Instantly move the visual along its local Y axis by yOffset units
(Inherited from Visual.)
Public methodTranslateLocalY(Double, Double)
Move the visual along its local Y axis by yOffset units, at the given speed.
(Inherited from Visual.)
Public methodTranslateLocalY(Double, Double, Double, Double)
Move the visual along its local Y axis by yOffset units, at the given speed and acceleration
(Inherited from Visual.)
Public methodTranslateLocalZ(Double)
Instantly move the visual along its local Z axis by zOffset units
(Inherited from Visual.)
Public methodTranslateLocalZ(Double, Double)
Move the visual along its local Z axis by zOffset units, at the given speed.
(Inherited from Visual.)
Public methodTranslateLocalZ(Double, Double, Double, Double)
Move the visual along its local Z axis by zOffset units, at the given speed and acceleration
(Inherited from Visual.)
Public methodTranslateX(Double)
Instantly move the visual along the model's X axis by xOffset units
(Inherited from Visual.)
Public methodTranslateX(Double, Double)
Move the visual along the model's X axis by xOffset units, at the given speed.
(Inherited from Visual.)
Public methodTranslateX(Double, Double, Double, Double)
Move the visual along the model's X axis by xOffset units, at the given speed and acceleration
(Inherited from Visual.)
Public methodTranslateY(Double)
Instantly move the visual along the model's Y axis by yOffset units
(Inherited from Visual.)
Public methodTranslateY(Double, Double)
Move the visual along the model's Y axis by yOffset units, at the given speed.
(Inherited from Visual.)
Public methodTranslateY(Double, Double, Double, Double)
Move the visual along the model's Y axis by yOffset units, at the given speed and acceleration.
(Inherited from Visual.)
Public methodTranslateZ(Double)
Instantly move the visual along the model's Z axis by zOffset units
(Inherited from Visual.)
Public methodTranslateZ(Double, Double)
Move the visual along the model's Z axis by zOffset units, at the given speed.
(Inherited from Visual.)
Public methodTranslateZ(Double, Double, Double, Double)
Move the visual along the model's Z axis by zOffset units, at the given speed and acceleration.
(Inherited from Visual.)
Public methodTurnTo(Matrix)
Immediate Matrix TurnTo
(Inherited from Visual.)
Public methodTurnTo(Vector3)
Turn to a new yaw pitch roll instantly.
(Inherited from Visual.)
Public methodTurnTo(Matrix, SpeedProfile) (Inherited from Visual.)
Public methodTurnTo(Matrix, Double) (Inherited from Visual.)
Public methodTurnTo(Vector3, Double)
Turn to a new yaw pitch roll in a fixed time.
(Inherited from Visual.)
Public methodTurnTo(Axis, Double, SpeedProfile) (Inherited from Visual.)
Public methodTurnTo(Axis, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Matrix, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Visual, Matrix, SpeedProfile)
Main Matrix TurnTo method
(Inherited from Visual.)
Public methodTurnTo(Visual, Matrix, Double) (Inherited from Visual.)
Public methodTurnTo(Axis, Double, SpeedProfile, RotationDirection) (Inherited from Visual.)
Public methodTurnTo(Axis, Double, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Matrix, Double, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Visual, Axis, Double, SpeedProfile) (Inherited from Visual.)
Public methodTurnTo(Visual, Axis, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Visual, Matrix, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Axis, Double, Double, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Visual, Axis, Double, SpeedProfile, RotationDirection) (Inherited from Visual.)
Public methodTurnTo(Visual, Axis, Double, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Visual, Matrix, Double, Double, Double) (Inherited from Visual.)
Public methodTurnTo(Visual, Axis, Double, Double, Double, Double) (Inherited from Visual.)
Public methodUnfreeze
Release the load in one position by making it dynamic.
(Inherited from Visual.)
Public methodUnstick
Reparents this (stuck) visual to the scene and restores its physics state.
(Inherited from Visual.)
Public methodWaitForAnimator (Inherited from Visual.)
Public methodWakeUpSurroundingVisuals
Wake up any surrounding loads that might have been disabled so they don't remain in midair.
(Inherited from Visual.)
Top
Events
  NameDescription
Public eventControlPointEndDragListeners
Occurs when a ControlPoint drag operation is completed.
(Inherited from Visual.)
Public eventControlPointStartDragListeners
Occurs when a ControlPoint drag operation is started.
(Inherited from Visual.)
Public eventDeletedListeners (Inherited from Visual.)
Public eventInitializeListeners
Occurs when the visual is initialized (OnInitialize).
(Inherited from Visual.)
Public eventResetListeners
Occurs when the visual is reset (OnReset).
(Inherited from Visual.)
Top
Fields
  NameDescription
Public fieldStatic memberLocationName
Top
Extension Methods
  NameDescription
Public Extension MethodAddToComponent(String, IEnumerableVisual)Overloaded.
Add a list of visuals to a component (or create a component).
(Defined by VisualComponent.)
Public Extension MethodAddToComponent(String, Visual)Overloaded.
Add a list of visuals to a component (or create a component).
(Defined by VisualComponent.)
Public Extension MethodAddToComponent(Visual, String, Boolean)Overloaded.
Mark this visual as a member of the component. Component must be the root of an existing component, or null. If deep is set, then this visual and all its descendants will be added to the component. If deep is not set but this visual is already a member of a component, then it and all its child visuals within the current component, will be moved to the new component.
(Defined by VisualComponent.)
Public Extension MethodBelongsToComponent
Returns true if this visual belongs to a specific component.
(Defined by VisualComponent.)
Public Extension MethodCommonComponentTypes
Returns the component types common between this visual and a list of other visuals.
(Defined by VisualComponent.)
Public Extension MethodComponent(String)Overloaded.
Returns the component root for this visual.
(Defined by VisualComponent.)
Public Extension MethodComponent(VisualComponentSearchCriteria)Overloaded.
Returns the component root for this visual.
(Defined by VisualComponent.)
Public Extension MethodComponentChildren(String)Overloaded.
Returns all children of this component.
(Defined by VisualComponent.)
Public Extension MethodComponentChildren(VisualComponentSearchCriteria)Overloaded.
Returns all children of this component.
(Defined by VisualComponent.)
Public Extension MethodComponentDescendants(String)Overloaded.
Returns all descendants of this component.
(Defined by VisualComponent.)
Public Extension MethodComponentDescendants(VisualComponentSearchCriteria)Overloaded.
Returns all descendants of this component.
(Defined by VisualComponent.)
Public Extension MethodComponents
Returns all the components to which this visual belongs.
(Defined by VisualComponent.)
Public Extension MethodComponentTypes
Returns an ordered list of all the component types to which this visual belongs.
(Defined by VisualComponent.)
Public Extension MethodComponentVisuals(String)Overloaded.
Returns all the visuals belonging to this component.
(Defined by VisualComponent.)
Public Extension MethodComponentVisuals(VisualComponentComponentType)Overloaded.
Returns all the visuals belonging to this component.
(Defined by VisualComponent.)
Public Extension MethodComponentVisuals(VisualComponentSearchCriteria)Overloaded.
Returns all the visuals belonging to this component.
(Defined by VisualComponent.)
Public Extension MethodCreateComponent
Mark this visual as a component.
(Defined by VisualComponent.)
Public Extension MethodFindComponentType(String)Overloaded.
Returns a component type for this visual.
(Defined by VisualComponent.)
Public Extension MethodFindComponentType(VisualComponentSearchCriteria)Overloaded.
Returns a component type for this visual.
(Defined by VisualComponent.)
Public Extension MethodIsComponentRoot(String)Overloaded.
Returns true if this visual is the root of its component.
(Defined by VisualComponent.)
Public Extension MethodIsComponentRoot(VisualComponentSearchCriteria)Overloaded.
Returns true if this visual is the root of its component.
(Defined by VisualComponent.)
Public Extension MethodIsComponentType
Returns true if this visual is a component member of componentType.
(Defined by VisualComponent.)
Public Extension MethodRemoveFromComponent
Remove this visual from component.
(Defined by VisualComponent.)
Top
See Also