SceneVisual Properties

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.

Returns all the aspects for this Visual.

Gets all connectors.

When true allow teleporting on to the default floor in exported Raw3d files or web servers.

If not set then a MissingFrictionCombination exception is thrown if two friction materials come into contact where there is no coefficient of friction defined for them in the document friction configuration matrix.

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>

How objects appear when they are in shadow.

How often the Analysis spreadsheet should be updated if there are pending changes to it and it's visible (in seconds).

Return all ancestor visuals above this point in the Visual hierarchy.

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.

Automatically resize the floor to fit what is on it.

Batches all output to the tag servers. Output generated by the model is batched over the course of a simulation step and passed to the tag servers at the end of each step.

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.

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.

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

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.

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.

The current state of the camera. Can be used to edit the FieldOfViewY for the current camera.

Return the collection of child Visuals.

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>

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>

Whether to automatically connect to any tag servers when the document is initialized.

Whether to automatically connect to any tag servers when the document is loaded.

All pairs of connectors from this visual.

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

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.

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.

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.

The global offset for conveyor direction arrows from their centers. This can be used to put all direction arrows to the side of conveyors so they aren't obscured by loads traveling on them. This is a positive or negative percentage value (of the individual conveyor widths).

The document that this Visual belongs to.

Whether the visual be dragged using the mouse.

A simple text based event log path for planar physics. If this is a non empty file path then all planar events will be logged to this file when the model is run.

When processing events in realtime process all events that will occur in the time range from now to now plus this duration. This makes event processing more CPU friendly. The default is 1ms.

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.

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.

The maximum size the floor can expand to in X or Z.

Size of the floor in an empty model.

Whether physics should be enabled for the floor. Disabling this will allow rigid bodies to fall through the floor.

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

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

The height of the scene floor.

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

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

Enable the fogging for the scene.

A matrix/table used to lookup friction coefficients from pairs of friction materials. The matrix/table is symmetric, so that the friction coefficient for material pair (a, b) is equal to the friction coefficient for material pair (b, a). It is possible to change the friction coefficients for pairs of friction materials.

The friction material for the scene floor.

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

The order that generators are given incremental initial seeds. This is optional but will ensure determinism of random number streams when additional streams are added later.

This is the increment to the InitialSeed that each individual random number generator is given OnInitialize.

The pseudo random number generator algorithm to use. This defaults to Mersenne Twister (MT19937).

The origin for the scene grid.

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

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.

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.

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.

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.

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.

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.

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

Whether this visual and all its ancestor visuals are Static.

Whether the visual's body is kinematic.

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.

If set to true then collisions are detected between pairs of loads. Otherwise, if set to false, collisions are not detected between pairs of loads. If you don't need to detect collisions between loads then it is recommended to set this property to false in order to reduce the computational cost of the physics pipeline.

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.

The discrete amount of time between advancing and solving mechanisms.

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

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)

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.

Occurs after a property of the parent visual is updated.

Occurs after a property of the visual is updated.

Occurs after a property of a visual that has this visual in its PropertyUpdatedSubscribers list is updated.

Occurs when an animator completes.

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.

Occurs before a property of the parent visual is updated.

Occurs before a property of the visual is updated.

Occurs when the visual is clicked on in demonstration/navigation mode.

Occurs when this visual is connected to another visual

Occurs after a custom property of the visual is renamed.

Occurs after a custom property of the visual is updated.

Occurs when this visual is disconnected from another visual

Occurs when a visual has finished being dragged to a new location.

Occurs when a visual is about to be dragged to a new location.

Occurs at the end of each experiment. This allows finalization of any data collection, for example.

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.

Occurs at the start of each experiment. This allows for initialization of any data collection, for example.

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.

Occurs when a load first contacts the floor.

Occurs when Play is pressed at time 0.

Occurs when a key is pressed or released and this visual is selected.

Occurs when a key is pressed and this visual is selected.

Occurs when the document is first opened.

Occurs when a message is sent from another visual's MessageListeners list.

Occurs when the mouse moves away from the visual.

Occurs when the mouse moves over the visual.

Occurs when the mouse enters the visual.

Occurs when a mouse button is released after being pressed on the visual.

Occurs when a visual has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit.

Occurs when a MoveTo or TurnTo has finished.

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.

Occurs when the parent for the visual changes.

Occurs before OnInitialize is called. The OnPreInitialize is called for every visual in one pass. Then a second pass calls OnInitialize for every visual.

Occurs if the document is running and falls behind by RealtimeLag or more. Useful for ensuring Controls Testing is in sync.

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.

Occurs when Reset is pressed.

(Inherited from Visual.)

Occurs when the status of the "Show Direction Arrows" configuration is changed.

Occurs when the model starts running after initialize or after it has been stopped/paused.

Occurs when the model stops running.

Occurs when the document is closed.

Occurs when a visual is added to the scene.

Occurs when a visual is removed from the scene.

When true optimizes all static visuals when exporting Raw3d files or starting a web server.

The parent Visual for this Visual.

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.

The length of time that a physics body must remain stationary before the physics engine will "sleep" the body. Physics engines put bodies into sleeping mode in order to avoid detecting collisions between two stationary objects and having to update their positions. This can improve the efficiency of the physics pipeline significantly.

The default collision margin for physics collision geometry belonging to the visual's PhysicsBody.

Whether the physics for the visual is enabled or not.

The volumetric physics engine to use. PhysX can be the fastest and is the default. Bullet is more configurable but not always as fast. ODE can be used for backwards compatibility with older models.

Obsolete

Obsolete

Obsolete

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.

Obsolete

The discrete amount of time that the physics world is advanced during each iteration of the physics pipeline. This value may be decreased for greater physics realism, or to help prevent tunneling, at a performance cost. Please note that this value should be considered in tandem with the number of PhysicsIterations when targeting greater physics realism or performance.

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>

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

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

The reflectivity of the material. 0 is non-reflective, 100 is a mirror. 10 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.

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.

Whether the control points for this visual should be rendered.

When true show the default floor when exporting Raw3d files or starting a web server.

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

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

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

Warn if we fall more than SimulationTransferTolerance onto a conveyor

A read-only report on the number of linear paths that are in use in the current linear physics simulation.

Maximum load overlap allowed in Simulation

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

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

Maximum gap allowed for automatic conveyor to conveyor transfer in Simulation

Stop the model running if an Error is logged.

Surface area of Visual and all its children.

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.

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

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.

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.

A dictionary of user key value pairs that can be used to store any custom data about the visual.

If set to true then collisions are detected between pairs of vehicles. Otherwise, if set to false, collisions are not detected between pairs of vehicles. If you don't need to detect collisions between vehicles then it is recommended to set this property to false in order to reduce the computational cost of the physics pipeline.

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

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

Return all ancestor visuals above this point in the Visual hierarchy, including the Visual itself.

Return all visuals below this point in the Visual hierarchy including the Visual itself.

Volume of Visual and all its children.

Configuration details for the Web server. The Web server allows external programs to interact with your model.

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