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