Click or drag to resize

BoxVisual Class

The physics primitive type to use for the box visual.
Inheritance Hierarchy

Namespace:  Demo3D.Visuals
Assembly:  Demo3D.Core (in Demo3D.Core.dll) Version: 15.0.2.11458
Syntax
C#
public class BoxVisual : PhysicsObject

The BoxVisual type exposes the following members.

Properties
  NameDescription
Public propertyAllAspectKeys (Inherited from CoreVisual.)
Public propertyAllAspects
Returns all the aspects for this Visual.
(Inherited from CoreVisual.)
Public propertyAllConnectors
Gets all connectors.
(Inherited from Visual.)
Public propertyAllowWaitOnMove
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 propertyAncestors
Return all ancestor visuals above this point in the Visual hierarchy.
(Inherited from Visual.)
Public propertyAngularDamping
Angular damping threshold for physics-based rotations
(Inherited from PhysicsObject.)
Public propertyAngularFactor
The world-space axes in which the rigid body is permitted to rotate. Values of one and zero specify that rotation is disabled and enabled respectively.
(Inherited from PhysicsObject.)
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 propertyAttachDirection
When attaching to a conveyor snap with the X axis align Forwards, Reverse or Nearest where Nearest means snap either way favoring the current relative orientation of the object.
(Inherited from PhysicsObject.)
Public propertyAttachPosition
The offset to snap to on a conveyor, useful for building vehicles which track the inner side of a conveyor loop.
(Inherited from PhysicsObject.)
Public propertyAttachToConveyor
If True, then the object will snap itself to the center line of a conveyor surface.
(Inherited from PhysicsObject.)
Public propertyAutoDisable
If True, then the body will disable itself after a certain period of inactivity. This is a physics optimization; inactive bodies will appear red in the physics view (press F8 to see physics view).
(Inherited from PhysicsObject.)
Public propertyBeingDragged (Inherited from PhysicsObject.)
Public propertyBillboard
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
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
The cost of the component as it appears in the bill of materials, e.g. "1595.95".
(Inherited from Visual.)
Public propertyBillOfMaterialsDescriptionExpr
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 propertyBlockedTime
The time the sensor was last blocked.
(Inherited from PhysicsObject.)
Public propertyBlockedTimeout
The amount of time to wait from a blocking event until the OnBlockedTimeout occurs. The event is not raised if the sensor is cleared during the timeout period.
(Inherited from PhysicsObject.)
Public propertyBlockingLoad (Inherited from PhysicsObject.)
Public propertyBlockingLoads (Inherited from PhysicsObject.)
Public propertyBodyType
'Visual Only' is just the graphics. 'Load' will be available to load creators and be affected by gravity. 'Vehicle' is like a load but isn't transient and remains in the scene after a Reset. 'Deflector' is fixed in space and will deflect other objects. 'Sensor' is fixed in space but will fire scripts when other objects come into contact with it.
(Inherited from PhysicsObject.)
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 propertyCastsShadow
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 propertyCcdMotionThreshold
The distance in one time step above which continuous collision detection is enabled. Setting this to zero disables continuous collision detection for the body.
(Inherited from PhysicsObject.)
Public propertyChildren
Return the collection of child Visuals.
(Inherited from Visual.)
Public propertyClearedTime
The time the sensor was last cleared.
(Inherited from PhysicsObject.)
Public propertyClearedTimeout
The amount of time to wait from a clearing event until the OnClearedTimeout occurs. The event is not raised if the sensor is blocked during the timeout period.
(Inherited from PhysicsObject.)
Public propertyClientOwnerUsername (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
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
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 propertyContactEnabled
If True, then the object will fire the OnContact event when another object collides with it. Objects usually bounce against other objects, so this property is set False after the event is raised.
(Inherited from PhysicsObject.)
Public propertyContactTimeout
The amount of time to wait from a contact event until the OnContactTimeout is fired.
(Inherited from PhysicsObject.)
Public propertyControlPointsAllowed
A white list of control points that should be shown and editable.
(Inherited from Visual.)
Public propertyControlPointsDisallowed
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 propertyDeflectorBlocksSensors
If true then the deflector is able to block and clear sensors. Useful when attached to a moving conveyor or vehicle to see when it reaches a certain position.
(Inherited from PhysicsObject.)
Public propertyDeleteOnReset
Whether the object should be deleted on reset or not.
(Inherited from PhysicsObject.)
Public propertyDeleteWhenFloorHit
If this is true and the body type is set to 'Load' and the load 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.
(Inherited from PhysicsObject.)
Public propertyDensity
The mass per unit volume of the box. The mass is calculated from the volume of the box.
Public propertyDepth
The depth of the box (Z axis dimension).
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 propertyExtraMaterials
Used when TextureMode is set to something other than Default.
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 propertyFixToParent
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 propertyFrictionMaterial
'Visual Only' is just the graphics. 'Load' will be available to load creators and be affected by gravity. 'Vehicle' is like a load but isn't transient and remains in the scene after a Reset. 'Deflector' is fixed in space and will deflect other objects. 'Sensor' is fixed in space but will fire scripts when other objects come into contact with it.
(Inherited from PhysicsObject.)
Public propertyFullName
The full name of this Visual, including the names of all Parent Visual separated by '.' characters.
(Inherited from Visual.)
Public propertyGravityEnabled
Whether the object is affected by gravity or not.
(Inherited from PhysicsObject.)
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
The height of the box (Y axis dimension).
Public propertyHideAdvancedProperties
(Inherited from Visual.)
Public propertyId
A unique identifier for this Visual.
(Inherited from Visual.)
Public propertyIncludeChildContextMenus
When right clicking on the object should child objects menu items be included. Default is false.
(Inherited from Visual.)
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
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.)
Public propertyInitialPositionOnReset
Moves the visual back to its initial location and rotation when Reset is pressed.
(Inherited from Visual.)
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 propertyIsBlocked (Inherited from PhysicsObject.)
Public propertyIsCleared (Inherited from PhysicsObject.)
Public propertyIsFloorVisual
Is this visual a floor visual.
(Inherited from MeshObject.)
Public propertyIsSimulationTransferInProgress (Inherited from Visual.)
Public propertyIsStatic
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.)
Public propertyIsVisible
There is a mesh and the properties are set to visible.
(Inherited from MeshObject.)
Public propertyIsWorldStatic
Whether this visual and all its ancestor visuals are Static.
(Inherited from Visual.)
Public propertyKinematic
If True and BodyType is Vehicle, then this body may be animated (with MoveTo, for example) such that it will interact correctly with loads. This is useful for building lift platforms, shuttles, etc.
(Inherited from PhysicsObject.)
Public propertyLayer
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 propertyLinearDamping
The percentage of the rigid body's linear velocity that is lost per second. This can be used to simulate air resistance.
(Inherited from PhysicsObject.)
Public propertyLinearFactor
The world-space axes in which the rigid body is permitted to rotate. Values of one and zero specify that rotation is disabled and enabled respectively.
(Inherited from PhysicsObject.)
Public propertyLocalCenterOfMassOffset
The local-space offset that is applied to the rigid body's center of gravity. Not supported by ODE.
(Inherited from PhysicsObject.)
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 propertyMass
Set the mass of the body. Setting this changes the density according to the bounding box.
(Inherited from PhysicsObject.)
Public propertyMaterial
The color and texture of the box.
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
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
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
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 propertyOnAfterParentPropertyUpdated
Occurs after a property of the parent visual is updated.
(Inherited from Visual.)
Public propertyOnAfterPropertyUpdated
Occurs after a property of the visual is updated.
(Inherited from Visual.)
Public propertyOnAfterSubscribedPropertyUpdated
Occurs after a property of a visual that has this visual in its PropertyUpdatedSubscribers list is updated.
(Inherited from Visual.)
Public propertyOnAnimatorCompleted
Occurs when an animator completes.
(Inherited from Visual.)
Public propertyOnAnimatorEvent
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.)
Public propertyOnAttachToVisual
Occurs when the physics object is attached to a conveyor.
(Inherited from PhysicsObject.)
Public propertyOnBeforeParentPropertyUpdated
Occurs before a property of the parent visual is updated.
(Inherited from Visual.)
Public propertyOnBeforePropertyUpdated
Occurs before a property of the visual is updated.
(Inherited from Visual.)
Public propertyOnBlocked
Occurs when the sensor is blocked.
(Inherited from PhysicsObject.)
Public propertyOnBlockedTimeout
Occurs when the sensor has been blocked for BlockedTimeout seconds (BodyType must be Sensor).
(Inherited from PhysicsObject.)
Public propertyOnChildAdded
Occurs when a child is parented to this visual after the reparenting has been performed.
(Inherited from Visual.)
Public propertyOnChildRemoved
Occurs when a child is unparented from this visual after the reparenting has been performed.
(Inherited from Visual.)
Public propertyOnCleared
Occurs when the sensor is cleared (BodyType must be Sensor).
(Inherited from PhysicsObject.)
Public propertyOnClearedTimeout
Occurs when the sensor has been cleared for ClearedTimeout seconds (BodyType must be Sensor).
(Inherited from PhysicsObject.)
Public propertyOnClick
Occurs when the visual is clicked on in demonstration/navigation mode.
(Inherited from Visual.)
Public propertyOnConnected
Occurs when this visual is connected to another visual
(Inherited from Visual.)
Public propertyOnContact
Occurs when BodyType is Deflector and something collides with the object.
(Inherited from PhysicsObject.)
Public propertyOnContactTimeout
Occurs when BodyType is Deflector and the OnContactTimeout occurs.
(Inherited from PhysicsObject.)
Public propertyOnCustomPropertyRenamed
Occurs after a custom property of the visual is renamed.
(Inherited from Visual.)
Public propertyOnCustomPropertyUpdated
Occurs after a custom property of the visual is updated.
(Inherited from Visual.)
Public propertyOnDetachFromVisual
Occurs when the physics object is detached from a conveyor.
(Inherited from PhysicsObject.)
Public propertyOnDisconnected
Occurs when this visual is disconnected from another visual
(Inherited from Visual.)
Public propertyOnDragEnd
Occurs when a visual has finished being dragged to a new location.
(Inherited from Visual.)
Public propertyOnDragStart
Occurs when a visual is about to be dragged to a new location.
(Inherited from Visual.)
Public propertyOnExperimentFinished
Occurs at the end of each experiment. This allows finalization of any data collection, for example.
(Inherited from Visual.)
Public propertyOnExperimentPreInitialize
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.)
Public propertyOnExperimentStarted
Occurs at the start of each experiment. This allows for initialization of any data collection, for example.
(Inherited from Visual.)
Public propertyOnExportBindableItem
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.)
Public propertyOnInitialize
Occurs when Play is pressed at time 0.
(Inherited from Visual.)
Public propertyOnKey
Occurs when a key is pressed or released and this visual is selected.
(Inherited from Visual.)
Public propertyOnKeyPress
Occurs when a key is pressed and this visual is selected.
(Inherited from Visual.)
Public propertyOnLoaded
Occurs when the document is loaded.
(Inherited from Visual.)
Public propertyOnMessage
Occurs when a message is sent from another visual's MessageListeners list.
(Inherited from Visual.)
Public propertyOnMouseLeave
Occurs when the mouse moves away from the visual.
(Inherited from Visual.)
Public propertyOnMouseMove
Occurs when the mouse moves over the visual.
(Inherited from Visual.)
Public propertyOnMouseOver
Occurs when the mouse enters the visual.
(Inherited from Visual.)
Public propertyOnMouseUp
Occurs when a mouse button is released after being pressed on the visual.
(Inherited from Visual.)
Public propertyOnMoved
Occurs 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
Occurs when a MoveTo or TurnTo has finished.
(Inherited from Visual.)
Public propertyOnParentMoved
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.)
Public propertyOnParentUpdated
Occurs when the parent for the visual changes.
(Inherited from Visual.)
Public propertyOnPreInitialize
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.)
Public propertyOnProcessContact
Occurs when processing volumetric physics contact points. Arguments are the sender, the load visual and the contact details (of type ContactInfo). Implementing this handler can severely impact performance.
(Inherited from PhysicsObject.)
Public propertyOnRenderType
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.)
Public propertyOnReportCollisionImpulse
Reports collision impulses. Reporting of impulses must be enabled on the Scene. Implementing this handler can severely impact performance.
(Inherited from PhysicsObject.)
Public propertyOnReset
Occurs when Reset is pressed.
(Inherited from Visual.)
Public propertyOnShortcut
(Inherited from Visual.)
Public propertyOnShowDirections
Occurs when the status of the "Show Direction Arrows" configuration is changed.
(Inherited from Visual.)
Public propertyOnUnloaded
Occurs when the document is unloaded
(Inherited from Visual.)
Public propertyOnVisualAdded
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.)
Public propertyOnVisualRemoved
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.)
Public propertyParent
The parent Visual for this Visual.
(Inherited from Visual.)
Public propertyPhysicsCollisionMargin
The default collision margin for physics collision geometry belonging to the visual's PhysicsBody.
(Inherited from Visual.)
Public propertyPhysicsEnabled
Whether the physics for the visual is enabled or not.
(Inherited from Visual.)
Public propertyPropertyUpdatedSubscribers
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 propertyReportSpecificChildVisual (Inherited from PhysicsObject.)
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 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 propertySaveSensorState (Inherited from PhysicsObject.)
Public propertySelectParentWhenPicked
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 propertySenseMultipleLoads
If true the OnBlocked and OnCleared are called for every load that blocks or clears the sensor. If false the events are only fired for the first load that blocks the sensor. Subsequent touching loads keep it blocked and the OnCleared occurs for the first load when the last load is cleared.
(Inherited from PhysicsObject.)
Public propertySimpleProperties
Enter a non-empty name for each property that should be shown in the Simple Properties view.
(Inherited from Visual.)
Public propertySoftness
How tolerant this object is to penetration from other objects.
(Inherited from PhysicsObject.)
Public propertySpeed
The current speed of the visual.
(Inherited from PhysicsObject.)
Public propertySurfaceArea
The surface area of the BoxVisual.
(Overrides MeshObjectSurfaceArea.)
Public propertySurfaceAreaDeep
Surface area of Visual and all its children.
(Inherited from Visual.)
Public propertyTags
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 propertyTextureMode
Default just uses Material on each face. DVD uses Material as the texture for the back, spine and front, and ExtraMaterials[0] for the other faces. Letter uses Material for the top, ExtraMaterial[0] for the bottom and ExtraMaterial[1] for the sides.
Public propertyToolTipExpr
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 propertyTracking
The properties to allow the object to track along and/or from side to side on a conveyor it is attached to. This allows vehicle movements like sorters, magic shoes, palletizers, etc.
(Inherited from PhysicsObject.)
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 propertyUseParentBody
When true, this visual will not create a rigid body of its own, but add its geom to its parent. This is useful for creating components from several visuals that must remain internally stable.
(Inherited from PhysicsObject.)
Public propertyUserData
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.)
Public propertyUserVars
A dictionary of user key value pairs that can be used to store any custom data about the visual.
(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
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
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
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 propertyVisualAndAncestors
Return all ancestor visuals above this point in the Visual hierarchy, including the Visual itself.
(Inherited from Visual.)
Public propertyVisualAndDescendants
Return all visuals below this point in the Visual hierarchy including the Visual itself.
(Inherited from Visual.)
Public propertyVolume
The volume of the BoxVisual.
(Overrides MeshObjectVolume.)
Public propertyVolumeDeep
Volume of Visual and all its children.
(Inherited from Visual.)
Public propertyWidth
The width of the box (X axis dimension).
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 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 methodAddAspect(Object) (Inherited from CoreVisual.)
Public methodAddAspect(Object, Boolean) Obsolete. (Inherited from Visual.)
Public methodCode exampleAddAspectT(T)
Add an aspect instance.
(Inherited from Visual.)
Public methodAddAspectT(T, Boolean) Obsolete. (Inherited from Visual.)
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.

Note: For most uses, AddCustomProperty(String, Object, String) or AddSimpleProperty(String, Object, String) is more suitable, because there is no need to pass the type parameter; it is taken automatically from the value. The only exception is if the value passed in is null, since we can't extract the type.

(Inherited from Visual.)
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. The property will also be hidden in the user interface.
(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 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 methodCreatePhysics (Inherited from PhysicsObject.)
Public methodCustomPropertyDefined

DEPRECATED: USE HasCustomProperty(String) INSTEAD.

Determines whether a custom property has been defined or not.
(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 methodFindAncestorsAspectT
Find the first aspect of type T on one of the visuals ancestors (parent, grand-parent, etc.).
(Inherited from Visual.)
Public methodFindAncestorsAspectsT
Finds all aspects of type T on any of this visual's ancestors.
(Inherited from Visual.)
Public methodFindAspect(Type)
Finds and returns an aspect of a given type.
(Inherited from CoreVisual.)
Public methodFindAspectT
Finds and returns an aspect of a given type.
(Inherited from CoreVisual.)
Public methodFindAspectsT
Find all aspects that can be cast to the given type.
(Inherited from CoreVisual.)
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 methodFindCreateAspect(Type)
Finds an aspect if it exists or Adds a new one if it doesn't exist.
(Inherited from CoreVisual.)
Public methodFindCreateAspectT
Finds an aspect if it exists or adds a new one if it doesn't exist.
(Inherited from CoreVisual.)
Public methodFindCreateConnector
Find or create a connector of the supplied name.
(Inherited from Visual.)
Public methodFindCreateManagedAspectT (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(PredicateVisual)
Go back up through the parents of visuals to find a particular parent that matches the supplied predicate.
(Inherited from Visual.)
Public methodFindParent(Type)
Go back up through the parents of visuals to find a particular parent type.
(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 methodCode exampleFindVisualAndAncestorsAspectT
Find the first aspect of type T on this visual or one of its ancestors (parents, grand-parents, etc.).
(Inherited from Visual.)
Public methodCode exampleFindVisualAndAncestorsAspectsT
Finds all aspects of type T on this visual or its ancestors.
(Inherited from Visual.)
Public methodCode exampleFindVisualAndDescendantsAspectT
Find the first aspect of type T on this visual or one of its descendents (children recursively)
(Inherited from Visual.)
Public methodCode exampleFindVisualAndDescendantsAspectsT
Find all aspects of type T on this visual or one of its descendents (children recursively)
(Inherited from Visual.)
Public methodFindVisualType
Find all the visuals that have their Type field set to 'type'.
(Inherited from Visual.)
Public methodFreeze
Hold the load in one position by making it kinematic.
(Inherited from Visual.)
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 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 exampleHasAspectT
Returns whether an aspect of a given type can be found on the visual.
(Inherited from Visual.)
Public methodCode exampleHasCustomProperty
Determines whether a custom property has been defined or not.
(Inherited from Visual.)
Public methodInitializeDefault (Inherited from Visual.)
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 methodIsFacingDirectionOfConveyorMotor (Inherited from PhysicsObject.)
Public methodMenuSetInitialPosition
(Inherited from Visual.)
Public methodCode exampleMoveTo(Matrix)
Move to a new matrix location instantly.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Vector3)
Move to a new location instantly.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Matrix, SpeedProfile)
Move to a new matrix location using a speed profile.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Matrix, Double)
Move to a new matrix location at a given speed.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Vector3, SpeedProfile)
Move to a new location given a speed profile.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Vector3, Double)
Move to a new location given a speed.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Matrix, Double, Double)
Move to a new matrix location at a given speed and acceleration.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Vector3, Double, Double)
Move to a new location given a speed and acceleration.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Visual, Matrix, SpeedProfile)
Move to a new matrix location relative to another visual.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Visual, Matrix, Double)
Move to a new matrix location relative to another visual.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Visual, Vector3, SpeedProfile)
Move to a new location relative to another visual.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Visual, Vector3, Double)
Move to a new location relative to another visual.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Matrix, Double, Double, Double)
Move to a new matrix location at a given speed, acceleration and deceleration.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Vector3, Double, Double, Double)
Move to a new location given a speed, acceleration, and deceleration.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Visual, Matrix, Double, Double)
Move to a new matrix location relative to another visual.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Visual, Vector3, Double, Double)
Move to a new location relative to another visual.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Visual, Matrix, Double, Double, Double)
Move to a new matrix location relative to another visual.
(Inherited from Visual.)
Public methodCode exampleMoveTo(Visual, Vector3, Double, Double, Double)
Move to a new location relative to another visual.
(Inherited from Visual.)
Public methodMoveToInitialPosition
Move to the InitialPosition and InitialRotation.
(Inherited from Visual.)
Public methodNotifyJointsChanged (Inherited from PhysicsObject.)
Protected methodNotifyMeshChanged (Inherited from Visual.)
Protected methodNotifyOnAfterParentPropertyUpdated (Inherited from PhysicsObject.)
Protected methodNotifyOnBeforePropertyUpdated (Inherited from PhysicsObject.)
Public methodNotifyOnDragEnd
FOR INTERNAL USE ONLY.
(Inherited from PhysicsObject.)
Public methodNotifyOnDragStart
FOR INTERNAL USE ONLY.
(Inherited from PhysicsObject.)
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 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 methodRecalculateConnections
Attach or detach connectors and accessories to or from valid connections on this visual and all children.
(Inherited from Visual.)
Public methodRemoveAspect(Object) (Inherited from CoreVisual.)
Public methodCode exampleRemoveAspect(Type)
Removes an aspect of a given type.
(Inherited from Visual.)
Public methodRemoveAspect(Object, Boolean) Obsolete. (Inherited from Visual.)
Public methodCode exampleRemoveAspectT
Removes an aspect.
(Inherited from Visual.)
Public methodRemoveAspectT(T)
Removes an aspect instance.
(Inherited from Visual.)
Public methodRemoveAspectT(T, Boolean) Obsolete. (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 methodReparent (Inherited from PhysicsObject.)
Public methodCode exampleRotate(Axis, SpeedProfile)
Set the visual rotating.
(Inherited from Visual.)
Public methodCode exampleRotate(Axis, Double)
Set the visual rotating.
(Inherited from Visual.)
Public methodCode exampleRotate(Axis, Double, Double)
Set the visual rotating.
(Inherited from Visual.)
Public methodCode exampleRotate(Visual, Axis, SpeedProfile)
Set the visual rotating.
(Inherited from Visual.)
Public methodCode exampleRotate(Visual, Axis, SpeedProfile, RotationDirection)
Set the visual rotating.
(Inherited from Visual.)
Public methodRotateByImmediate (Inherited from Visual.)
Public methodCode exampleRotateToImmediate
Rotate immediately around a given local axis to a given angle relative to the visual's initial position.
(Inherited from Visual.)
Public methodCode exampleRotateToLocalX
Rotate around the local X axis a given amount at a given speed.
(Inherited from Visual.)
Public methodCode exampleRotateToLocalY
Rotate around the local Y axis a given amount at a given speed.
(Inherited from Visual.)
Public methodCode exampleRotateToLocalZ
Rotate around the local Z axis a given amount at a given speed.
(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 methodSetIsStaticDeep
Set the IsStatic property for this Visual and all children recursively.
(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 CoreVisual.)
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 methodToStream
Convert a visual to a stream containing XML. Use Document.CreateVisual to turn it back into a copy of the original visual.
(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 methodTransformTrackToWorld
Transform a tracking location to a world location. Offset is Props.Tracking.Offset, and is used to translate the [0,0,0] away from [start of conveyor, top of roller, center of roller].
(Inherited from PhysicsObject.)
Public methodTransformWorldToTrack
Transform a world location into a tracking location. Offset is Props.Tracking.Offset, and is used to translate the [0,0,0] away from [start of conveyor, top of roller, center of roller].
(Inherited from PhysicsObject.)
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 methodCode exampleTurnTo(Matrix)
Immediate Matrix TurnTo
(Inherited from Visual.)
Public methodCode exampleTurnTo(Vector3)
Turn to a new yaw pitch roll instantly.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Matrix, SpeedProfile)
Main Matrix TurnTo method
(Inherited from Visual.)
Public methodCode exampleTurnTo(Matrix, Double)
Matrix TurnTo method
(Inherited from Visual.)
Public methodCode exampleTurnTo(Vector3, Double)
Turn to a new yaw pitch roll in a fixed time.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Axis, Double, SpeedProfile)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Axis, Double, Double)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Matrix, Double, Double)
Matrix TurnTo method
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Matrix, SpeedProfile)
Main Matrix TurnTo method
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Matrix, Double)
Matrix TurnTo method
(Inherited from Visual.)
Public methodCode exampleTurnTo(Axis, Double, SpeedProfile, RotationDirection)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Axis, Double, Double, Double)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Matrix, Double, Double, Double)
Matrix TurnTo method
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Axis, Double, SpeedProfile)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Axis, Double, Double)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Matrix, Double, Double)
Matrix TurnTo method
(Inherited from Visual.)
Public methodCode exampleTurnTo(Axis, Double, Double, Double, Double)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Axis, Double, SpeedProfile, RotationDirection)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Axis, Double, Double, Double)
Turns to a target rotation.
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Matrix, Double, Double, Double)
Matrix TurnTo method
(Inherited from Visual.)
Public methodCode exampleTurnTo(Visual, Axis, Double, Double, Double, Double)
Turns to a target rotation.
(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 eventAfterCreatePhysics
An event that is executed after physics has been created for the physics object.
(Inherited from PhysicsObject.)
Public eventAfterDestroyPhysics
An event that is executed after physics has been destroyed for the physics object.
(Inherited from PhysicsObject.)
Public eventCode exampleAspectRemoved
Raised when an aspect is removed from this Visual.
(Inherited from Visual.)
Public eventBeforeCreatePhysics
An event that is executed before physics is created for the physics object.
(Inherited from PhysicsObject.)
Public eventBeforeDestroyPhysics
An event that is executed before physics is destroyed for the physics object.
(Inherited from PhysicsObject.)
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 eventMeshChanged
Occurs when the mesh of the visual is changed.
(Inherited from Visual.)
Public eventResetListeners
Occurs when the visual is reset (OnReset).
(Inherited from Visual.)
Top
Fields
  NameDescription
Protected fieldcontrolPoints (Inherited from PhysicsObject.)
Public fieldOnProcessCleared (Inherited from Visual.)
Public fieldOnProcessCollision (Inherited from Visual.)
Public fieldOnReportCollisionImpulse (Inherited from Visual.)
Top
See Also