SceneVisual Class

Field Value

Type: 
Add this as a world offset to any align operation using a control point or axis restricted drag of an object. This allows objects to be aligned to one another with an offset, e.g. 10mm or 1 inch below the top of another object.

Gets all connectors.

Field Value

Type: 
Undocumented

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>

Field Value

Type: 
How objects appear when they are in shadow.

The current angular velocity of the Visual in radians/second.

Determine if any animations are currently in progress for this Visual.

The global application object.

Field Value

Type: 
Automatically resize the floor to fit what is on it.

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.

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.

Field Value

Type: 
The cost of the component as it appears in the bill of materials, e.g. "1595.95".

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.

Field Value

Type: 
The bottom color for the project backdrop color gradient.

Get the bounding box of this visual including all its children.

Get the bounding sphere of this visual, including its children.

Field Value

Type: 
Undocumented

Return the collection of child Visuals.

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>

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>

Field Value

Type: 
Undocumented

All pairs of connectors from this visual.

Field Value

Type: 
A white list of control points that should be shown and editable.

Field Value

Type: 
A black list of control points that should be hidden and not editable.

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.

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.

Information about the current transfer in progress for this visual using the Transfer Protocol. This is normally set for loads.

The collection of CustomProperty objects for this Visual.

Field Value

Type: 
When a new visual is added it is added to this floor. If not set then new visuals are added directly to the scene. This doesn't apply to loads from a load creator.

Field Value

Type: 
When a load hits the floor it will automatically be deleted after this number of seconds provided its 'Delete When Floor Hit' flag is set

Return all visuals below this point in the Visual hierarchy .

Return all visuals below this point in the Visual hierarchy .

A description of the Visual.

Field Value

Type: 
Undocumented

The document that this Visual belongs to.

Whether the visual be dragged using the mouse.

Field Value

Type: 
Undocumented

Field Value

Type: 
Undocumented

Number of faces in Mesh for Visual and all its children.

The first child visual of this visual, or null if this visual has no children.

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.

Field Value

Type: 
Undocumented

Field Value

Type: 
Size of the floor in an empty model

Field Value

Type: 
The path name of the texture file for the scene floor.

Field Value

Type: 
The width/length of the floor tile texture in model space.

Field Value

Type: 
Undocumented

Field Value

Type: 
The color to use for fogging. This represents the color that the scene will blend to at the rear of the scene.

Field Value

Type: 
The rate with which the fog color will appear. A high number will fog the scene quickly and a low number gradually.

Field Value

Type: 
Enable the fogging for the scene.

Field Value

Type: 
A matrix of material combinations to friction coefficients,

Field Value

Type: 
The friction material used for the floor.

The full name of this Visual, including the names of all Parent Visual separated by '.' characters.

Field Value

Type: 
Undocumented

Field Value

Type: 
The path name of the texture file for the scene floor when in build mode.

Field Value

Type: 
The width/length of the grid tile texture in model space.

Determine if this Visual has any children or not.

Determine if this Visual has any siblings or not.

(Inherited from Visual.)

A unique identifier for this Visual.

Field Value

Type: 
When right clicking on the object should child objects menu items be included. Default is false.

The InitialLocation of the Visual in meters from the Origin of the Parent Visual.

The InitialLocation and InitialRotation in Matrix form.

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.

Field Value

Type: 
Moves the visual back to its initial location and rotation when Reset is pressed.

The InitialRotation of the Visual in degrees relative to the Rotation of Parent Visual.

The InitialRotation in Matrix form.

The InitialRotation of the Visual in radians relative to the Rotation of Parent Visual.

Field Value

Type: 
On load or reset the random number seed for the demonstration will be set to this number. Change this to produce a different demonstration.

The InitialLocation of this Visual and all its Parent Visuals in Matrix form.

The InitialLocation and InitialRotation of this Visual and all its Parent Visuals in Matrix form.

Determines whether the Visual is currently visible given the state of layers, etc.

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.

Field Value

Type: 
Undocumented

The visual's X, Y, and Z coordinates relative to its parent.

The visual's X coordinate relative to its parent.

The visual's Y coordinate relative to its parent.

The visual's Z coordinate relative to its parent.

The current matrix transform of the Visual local to its Parent Visual.

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>

The name of the Visual.

The native C# scripting class instance for this visual

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)

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.

The next sibling of this visual, or null if this visual has no siblings.

(Inherited from Visual.)

(Inherited from Visual.)

(Inherited from Visual.)

Field Value

Type: 
Undocumented

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.)

(Inherited from Visual.)

Field Value

Type: 
Call this script when the visual is clicked on in demonstration/navigation mode.

Field Value

Type: 
Call this script whenever this visual is connected to another visual

(Inherited from Visual.)

Field Value

Type: 
Call this script when this visual is disconnected from another visual

Field Value

Type: 
Call this script when a visual has finished being dragged to a new location.

Field Value

Type: 
Call this script when a visual is about to be dragged to a new location.

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>

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>

Field Value

Type: 
Undocumented

Field Value

Type: 
The script to run when Play is pressed at time 0.

Field Value

Type: 
Call this script when a key is pressed and this visual is selected.

Field Value

Type: 
Call this script when the document is first opened.

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>

Field Value

Type: 
Undocumented

Field Value

Type: 
Undocumented

Field Value

Type: 
Undocumented

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.

Field Value

Type: 
Call this script when a MoveTo or TurnTo has finished.

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.

Field Value

Type: 
Undocumented

(Inherited from Visual.)

Field Value

Type: 
Call this script when the document is running and falls behind by RealtimeLag or more. Useful for ensuring OPC Controls testing is in sync.

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.

Field Value

Type: 
The script to be run when Reset is pressed.

Field Value

Type: 
Call this script when the status of the "Show Direction Arrows" configuration is changed.

Field Value

Type: 
Undocumented

Field Value

Type: 
Undocumented

Field Value

Type: 
Call this script when the document is closed.

Field Value

Type: 
Call this script when a visual is added to the scene.

Field Value

Type: 
Call this script when a visual is removed from the scene.

The parent Visual for this Visual.

Field Value

Type: 
Add this to the location of the last pasted object. Can be used to replicate a conveyor or other object multiple times with equal spacing.

Field Value

Type: 
Undocumented

Whether the physics for the visual is enabled or not.

Field Value

Type: 
Undocumented

Field Value

Type: 
Undocumented

Field Value

Type: 
Undocumented

Field Value

Type: 
The type of Physics being used; Volumetric, Planar or Linear. Setting this is ignored if the model is not in the Reset state or if the edition being run does not support the specified mode.

Field Value

Type: 
Undocumented

Field Value

Type: 
Undocumented

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>

Field Value

Type: 
Call the OnRealtimeLag script if the running document gets this number of seconds or more behind real time.

Field Value

Type: 
The paths to external .NET assemblies that are used in the project. These can be absolute paths or relative to the directory containing the Demo3D.exe file (usually C:\Program Files\Demo3D ...\).

Field Value

Type: 
The reflectivity of the material. 0 is non-reflective, 1 is a mirror. 0.1 is a good value for conveyor surfaces.

The rotation of the Visual (in degrees) relative to ts Parent Visual.

The rotation of this Visual relative to its Parent in Matrix form.

The rotation of the Visual (in radians) relative to its Parent Visual.

The X rotation of the Visual (in degrees) relative to its Parent Visual.

The X rotation of the Visual (in radians) relative to its Parent Visual.

The Y rotation of the Visual (in degrees) relative to its Parent Visual.

The Y rotation of the Visual (in radians) relative to its Parent Visual.

The Z rotation of the Visual (in degrees) relative to its Parent Visual.

The Z rotation of the Visual (in radians) relative to its Parent Visual.

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.

Field Value

Type: 
Undocumented

Field Value

Type: 
Turn on/off the drawing of the floor beneath the conveyor sections.

Field Value

Type: 
Turn on/off the drawing of the conveyor support stands.

Field Value

Type: 
Enter a non-empty name for each property that should be shown in the Simple Properties view.

Field Value

Type: 
Warn if we fall more than SimulationTransferTolerance onto a conveyor

Field Value

Type: 
Undocumented

Field Value

Type: 
Maximum load overlap allowed in Simulation

Field Value

Type: 
Warn if we get loads overlapping by more than SimulationOverlapTolerance in Simulation

Field Value

Type: 
Maximum distance from a sensor that can trigger an OnBlocked or OnCleared event in Simulation

Field Value

Type: 
Maximum gap allowed for automatic conveyor to conveyor transfer in Simulation

Field Value

Type: 
Configuration details for the SOAP server. The SOAP server allows external programs to interact with your model.

Field Value

Type: 
Stop the model running if an Error is logged.

Surface area of Visual and all its children.

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.

Field Value

Type: 
The format string for the tooltip that appears for an object.

Field Value

Type: 
The top color for the project backdrop color gradient.

Get the top level visual, the one which has no parent.

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).

Whether this visual supports the Transfer Protocol. This is normally set for transfer enabled equipment (not loads).

A type string for the Visual.

(Inherited from Visual.)

(Inherited from Visual.)

Field Value

Type: 
Undocumented

The current linear velocity of the Visual in meters/second.

Number of vertices in Mesh for Visual and all its children.

Volume of Visual and all its children.

The world axis aligned bounding box of this Visual including the bounding boxes of all the child visuals and their children.

The world axis aligned bounding box of this Visual only (excluding any children).

Get the bounding sphere of this visual, including its children, in world space relative to the Scene.

Get the bounding sphere of this visual, excluding its children, in world space relative to the Scene.

The visual's world X, Y, and Z coordinates relative to the Scene.

The visual's world X coordinate relative to the Scene.

The visual's world Y coordinate relative to the Scene.

The visual's world Z coordinate relative to the Scene.

The Location and Rotation of this Visual in Matrix form.

The world rotation of the Visual (in degrees) relative to the Scene.

The rotation of this Visual relative to the Scene in Matrix form.

The world rotation of the Visual (in radians) relative to the Scene.

The world X rotation of the Visual (in degrees) relative to the Scene.

The world X rotation of the Visual (in radians) relative to the Scene.

The world Y rotation of the Visual (in degrees) relative to the Scene.

The world Y rotation of the Visual (in radians) relative to the Scene.

The world Z rotation of the Visual (in degrees) relative to the Scene.

The world Z rotation of the Visual (in radians) relative to the Scene.

The world X-Axis for the visual

The world Y-Axis for the visual

The world Z-Axis for the visual

Add a custom property to the visual. If the custom property already exists, then this call will update its value and description.

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.

Add a custom property and also add a PropertyAlias for that new customer property making it appear as a Simple Property.

Add a custom property and also add a PropertyAlias for that new customer property making it appear as a Simple Property.

Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.

Create a temporary custom property that won't persistent on disk when saved.

Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.

Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.

Align the mesh bounding box of the Visual to the default FloorVisual of the Scene.

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.

Cancel any animations that are currently in progress.

Return a List<Visual> representing all the children of this visual

Create a copy of a visual and its children placed in the top level scene.

Find the visual that is attached to the supplied connectorName.

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.

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.

Is the visual contained by the visual tree from this point down?

Is the child a direct child of the visual.

Determine whether a given custom property name is defined.

Delete this visual. If it is in a Document, it is removed from the document as well.

Disconnect any connections on the supplied connector name.

Animate the primary color of a visual and all its descendants in a given time.

Animate the transparency of a visual and all its descendants in a given time.

Return the collection of child Visuals that match the given predicate.

Return all visuals below this point in the Visual hierarchy that match the given predicate.

Look through children and their children to find the first visual of a given name. Breadth first search.

Find a named connector on a conveyor object, e.g. "Start"

Find or create a connector of the supplied name.

Find a custom property by name if it exists. Otherwise return null.

Like FindType except it return the first instance of that type.

Look through children to find a named visual.

Look through children to find all immediate children with a given name.

Find all the objects in the Children of type Type (immediate children only)

Find all the objects in the Children of type Type (immediate children only)

Go back up through the parents of visuals to find a particular parent type.

Go back up through the parents of visuals to find a particular parent that matches the supplied predicate.

Find all the objects in the Descendants of type Type (all descendants)

Find all the objects in the Descendants of type Type (all descendants)

Find all the visuals that have their Type field set to 'type'.

Hold the load in one position by making it kinematic.

Get the container class for a custom property, or null if it doesn't exist.

Get the value of a custom property, or null if it doesn't exist.

Get the value of a custom property, or a defaultValue if it doesn't exist.

Set the Location and Rotation of the Visual to be the same as the InitialLocation and InitialRotation.

Set the Rotation of the Visual to be the same as the InitialRotation. The Location remains unchanged.

Determines whether a custom property has been defined or not.

Is this Visual a parent, grandparent, great grandparent etc. of the potentialChild.

Determine if the Visual been deleted.

Move to the InitialPosition and InitialRotation.

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".

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.

Remove a connector with a certain name.

Remove a custom property from the Visual.

Remove this visual from the current parent's list of children (if current parent is not null), and add it to the new parent's list of children (if new parent is not null). The visual's matrix is adjusted accordingly, such that its top-level world location and orientation is preserved.

Set the value of a custom property or do nothing if it doesn't exist.

Set InitialLocation to be the current Location and InitialRotation to be the current Rotation.

Set the native C# scripting class instance for this visual

Atomically set the Script and NativeTypeName together but only create the NativeObject once.

Indicates that this Visual should now be in control of simulating the supplied load.

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.

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.

Convert a visual to XML. Use Document.CreateVisual to turn it back into a copy of the original visual.

Transform a world coordinate to a local coordinate

Transform a world normal to a local normal

Transform a world rotation (in degrees) to a local rotation (in degrees).

Transform a world rotation (in radians) to a local rotation (in radians).

Transform a local coordinate to coordinate local to parent.

Transform a local normal to normal local to parent

Transform a local coordinate to a world coordinate.

Transform a local normal to a world normal.

Transform a local rotation (in radians) to a world rotation (in radians).

Transform a local rotation (in radians) to a world rotation (in radians).

Instantly move the visual along its local X axis by xOffset units

Move the visual along its local X axis by xOffset units, at the given speed.

Move the visual along its local X axis by xOffset units, at the given speed and acceleration

Instantly move the visual along its local Y axis by yOffset units

Move the visual along its local Y axis by yOffset units, at the given speed.

Move the visual along its local Y axis by yOffset units, at the given speed and acceleration

Instantly move the visual along its local Z axis by zOffset units

Move the visual along its local Z axis by zOffset units, at the given speed.

Move the visual along its local Z axis by zOffset units, at the given speed and acceleration

Instantly move the visual along the model's X axis by xOffset units

Move the visual along the model's X axis by xOffset units, at the given speed.

Move the visual along the model's X axis by xOffset units, at the given speed and acceleration

Instantly move the visual along the model's Y axis by yOffset units

Move the visual along the model's Y axis by yOffset units, at the given speed.

Move the visual along the model's Y axis by yOffset units, at the given speed and acceleration.

Instantly move the visual along the model's Z axis by zOffset units

Move the visual along the model's Z axis by zOffset units, at the given speed.

Move the visual along the model's Z axis by zOffset units, at the given speed and acceleration.

Immediate Matrix TurnTo

Turn to a new yaw pitch roll instantly.

Turn to a new yaw pitch roll in a fixed time.

Main Matrix TurnTo method

Release the load in one position by making it dynamic.

Reparents this (stuck) visual to the scene and restores its physics state.

Wake up any surrounding loads that might have been disabled so they don't remain in midair.

Occurs when a ControlPoint drag operation is completed.

Occurs when a ControlPoint drag operation is started.

Occurs when the visual is deleted (Delete).

Occurs when the visual is initialized (OnInitialize).

Occurs when the visual is reset (OnReset).

Add a list of visuals to a component (or create a component).

Add a list of visuals to a component (or create a component).

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.

Returns true if this visual belongs to a specific component.

Returns the component types common between this visual and a list of other visuals.

Returns the component root for this visual.

Returns the component root for this visual.

Returns all children of this component.

Returns all children of this component.

Returns all descendants of this component.

Returns all descendants of this component.

Returns all the components to which this visual belongs.

Returns an ordered list of all the component types to which this visual belongs.

Returns all the visuals belonging to this component.

Returns all the visuals belonging to this component.

Returns all the visuals belonging to this component.

Mark this visual as a component.

Returns a component type for this visual.

Returns a component type for this visual.

Returns true if this visual is the root of its component.

Returns true if this visual is the root of its component.

Returns true if this visual is a component member of componentType.

Remove this visual from component.