Scene |
A scene is the top-level visual that owns all other objects to be drawn,
and also draws a floor.
Inheritance HierarchySystemObject
System.DynamicDynamicObject
NotifyPropertyChangedBase
Demo3D.VisualsVisual
Demo3D.VisualsCoreVisual
Demo3D.VisualsSceneVisual
System.DynamicDynamicObject
NotifyPropertyChangedBase
Demo3D.VisualsVisual
Demo3D.VisualsCoreVisual
Demo3D.VisualsSceneVisual
Namespace: Demo3D.Visuals
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 19.00.00
SyntaxC#
public class SceneVisual : CoreVisual
The SceneVisual type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AlignOffset | 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. |
| AllAspects |
Returns all the aspects for this Visual.
(Inherited from CoreVisual) |
| AllConnectors | Gets all connectors. (Inherited from Visual) |
| AllowTeleportOnDefaultFloorInExport | When true allow teleporting on to the default floor in exported Raw3d files or web servers. |
| AllowUndefinedFriction | 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. |
| 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> (Inherited from Visual) |
| AmbientIntensity | Linearly scales the intensity of the ambient light. Can be used to brighten/darken the shadows of objects. |
| AmbientLight | The color of ambient light that permeates throughout the scene. Can be used to brighten/darken the shadows of objects. |
| AmbientSourceType | Where the source of the ambient light comes from. The default setting uses only the ambient light intensity and diffuse color. Alternatively, the furthermost parts of the scene (the sky) may be included. |
| AnalysisUpdateInterval | How often the Analysis spreadsheet should be updated if there are pending changes to it and it's visible (in seconds). |
| Ancestors |
Return all ancestor visuals above this point in the Visual hierarchy.
(Inherited from Visual) |
| AngularVelocity |
The current angular velocity of the Visual in radians/second.
(Inherited from Visual) |
| AnimatorInProgress |
Determine if any animations are currently in progress for this Visual.
(Inherited from Visual) |
| App |
The global application object.
(Inherited from Visual) |
| AutoSize | Automatically resize the floor to fit what is on it. |
| 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. (Inherited from Visual) |
| 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. (Inherited from Visual) |
| BillOfMaterialsCostExpr | The cost of the component as it appears in the bill of materials, e.g. "1595.95". (Inherited from Visual) |
| 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. (Inherited from Visual) |
| BottomColor | The bottom color for the project backdrop color gradient. |
| BoundingBox |
Get the bounding box of this visual including all its children.
(Inherited from Visual) |
| BoundingBoxExcludingChildren | (Overrides VisualBoundingBoxExcludingChildren) |
| BoundingSphere |
Get the bounding sphere of this visual, including its children.
(Inherited from Visual) |
| BoundingSphereExcludingChildren | (Overrides VisualBoundingSphereExcludingChildren) |
| Camera | The current state of the camera. Can be used to edit properties affecting the field of view, depth of field, clipping distances, and more for the current camera. |
| CCD | Whether Continuous Collision Detection (CCD) should be performed when running in volumetric physics. Fast moving bodies must have their CCD motion threshold set to a non-zero positive value. |
| Children |
Return the collection of child Visuals.
(Inherited from Visual) |
| ClientOwnerUsername | (Inherited from Visual) |
| 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>
(Inherited from Visual) |
| 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>
(Inherited from Visual) |
| ConnectOnInitialize | Whether to automatically connect to any tag servers when the document is initialized. |
| ConnectOnLoad | Whether to automatically connect to any tag servers when the document is loaded. |
| ConnectorPairs |
All pairs of connectors from this visual.
(Inherited from Visual) |
| ControlPointsAllowed | A white list of control points that should be shown and editable. (Inherited from Visual) |
| ControlPointsDisallowed | A black list of control points that should be hidden and not editable. (Inherited from Visual) |
| 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.
(Inherited from Visual) |
| 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.
(Inherited from Visual) |
| CurrentTransfer |
Information about the current transfer in progress for this visual using the Transfer Protocol.
This is normally set for loads.
(Inherited from Visual) |
| CustomProperties |
The collection of CustomProperty objects for this Visual.
(Inherited from Visual) |
| DefaultFloor | 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. |
| DeleteLoadsAfter | 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 |
| Descendants |
Return all visuals below this point in the Visual hierarchy .
(Inherited from Visual) |
| DescendantsDepthFirst |
Return all visuals below this point in the Visual hierarchy .
(Inherited from Visual) |
| Description |
A description of the Visual.
(Inherited from Visual) |
| DirectionArrowOffset | 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). |
| Document |
The document that this Visual belongs to.
(Inherited from Visual) |
| Draggable |
Whether the visual be dragged using the mouse.
(Inherited from Visual) |
| EventLogPath | 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. |
| EventTimeStep | 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. |
| FaceCount | (Overrides VisualFaceCount) |
| FaceCountDeep |
Number of faces in Mesh for Visual and all its children.
(Inherited from Visual) |
| FirstChild |
The first child visual of this visual, or null if this visual has no children.
(Inherited from Visual) |
| 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. (Inherited from Visual) |
| FloorMaximumSize | The maximum size the floor can expand to in X or Z. |
| FloorMinimumSize | Size of the floor in an empty model. |
| FloorPhysicsEnabled | Whether physics should be enabled for the floor. Disabling this will allow rigid bodies to fall through the floor. |
| FloorTextureName | The path name of the texture file for the scene floor. |
| FloorTileSize | The width/length of the floor tile texture in model space. |
| FloorY | The height of the scene floor. |
| FogColor | The color to use for fogging. This represents the color that the scene will blend to at the rear of the scene. |
| FogDensity | The rate with which the fog color will appear. A high number will fog the scene quickly and a low number gradually. |
| FogEnabled | Enable the fogging for the scene. |
| FrictionConfiguration | 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. |
| FrictionMaterial | The friction material for the scene floor. |
| FullName |
The full name of this Visual, including the names of all Parent Visual separated by '.' characters.
(Inherited from Visual) |
| GeneratorOrder | 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. |
| GeneratorSeedIncrement | This is the increment to the InitialSeed that each individual random number generator is given OnInitialize. |
| GeneratorType | The pseudo random number generator algorithm to use. This defaults to Mersenne Twister (MT19937). |
| GridOrigin | The origin for the scene grid. |
| GridTextureName | The path name of the texture file for the scene floor when in build mode. |
| GridTileSize | The width/length of the grid tile texture in model space. |
| HasChildren |
Determine if this Visual has any children or not.
(Inherited from Visual) |
| HasNextSibling |
Determine if this Visual has any siblings or not.
(Inherited from Visual) |
| HideAdvancedProperties | (Inherited from Visual) |
| HierarchyColor | The background color of the Visual in the hierarchy (Inherited from Visual) |
| Id |
A unique identifier for this Visual.
(Inherited from Visual) |
| IncludeChildContextMenus | When right clicking on the object should child objects menu items be included. Default is false. (Inherited from Visual) |
| InitialLocation |
The InitialLocation of the Visual in meters from the Origin of the Parent Visual.
(Inherited from Visual) |
| InitialMatrix |
The InitialLocation and InitialRotation in Matrix form.
(Inherited from Visual) |
| 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. (Inherited from Visual) |
| InitialPositionOnReset | Moves the visual back to its initial location and rotation when Reset is pressed. (Inherited from Visual) |
| InitialRotationDegrees |
The InitialRotation of the Visual in degrees relative to the Rotation of Parent Visual.
(Inherited from Visual) |
| InitialRotationMatrix |
The InitialRotation in Matrix form.
(Inherited from Visual) |
| InitialRotationRadians |
The InitialRotation of the Visual in radians relative to the Rotation of Parent Visual.
(Inherited from Visual) |
| InitialSeed | On load or reset the random number seed for the demonstration will be set to this number. Change this to produce a different demonstration. |
| InitialWorldLocation |
The InitialLocation of this Visual and all its Parent Visuals in Matrix form.
(Inherited from Visual) |
| InitialWorldMatrix |
The InitialLocation and InitialRotation of this Visual and all its Parent Visuals in Matrix form.
(Inherited from Visual) |
| IsHttpListening | Obsolete |
| IsSimulationTransferInProgress | (Inherited from Visual) |
| 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.
(Inherited from Visual) |
| IsVisible |
Determines whether the Visual is currently visible given the state of layers, etc.
(Inherited from Visual) |
| IsWorldStatic |
Whether this visual and all its ancestor visuals are Static.
(Inherited from Visual) |
| Kinematic |
Whether the visual's body is kinematic.
(Inherited from Visual) |
| 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. (Inherited from Visual) |
| LoadsCollide | 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. |
| Location |
The visual's X, Y, and Z coordinates relative to its parent.
(Inherited from Visual) |
| LocationX |
The visual's X coordinate relative to its parent.
(Inherited from Visual) |
| LocationY |
The visual's Y coordinate relative to its parent.
(Inherited from Visual) |
| LocationZ |
The visual's Z coordinate relative to its parent.
(Inherited from Visual) |
| Matrix |
The current matrix transform of the Visual local to its Parent Visual.
(Inherited from Visual) |
| MechanismsTimeStep | The discrete amount of time between advancing and solving mechanisms. |
| MeshBoundingBox | (Overrides VisualMeshBoundingBox) |
| MeshBoundingSphere | (Overrides VisualMeshBoundingSphere) |
| 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>
(Inherited from Visual) |
| Name |
The name of the Visual.
(Inherited from Visual) |
| NativeObject |
The native C# scripting class instance for this visual
(Inherited from 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) (Inherited from Visual) |
| 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. (Inherited from Visual) |
| NextSibling |
The next sibling of this visual, or null if this visual has no siblings.
(Inherited from Visual) |
| OnAfterParentPropertyUpdated | Occurs after a property of the parent visual is updated. (Inherited from Visual) |
| OnAfterPropertyUpdated | Occurs after a property of the visual is updated. (Inherited from Visual) |
| OnAfterSubscribedPropertyUpdated | Occurs after a property of a visual that has this visual in its PropertyUpdatedSubscribers list is updated. (Inherited from Visual) |
| OnAnimatorCompleted | Occurs when an animator completes. (Inherited from Visual) |
| 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. (Inherited from Visual) |
| OnAspectRenamed | Occurs after an aspect on the visual is renamed. (Inherited from Visual) |
| OnBeforeParentPropertyUpdated | Occurs before a property of the parent visual is updated. (Inherited from Visual) |
| OnBeforePropertyUpdated | Occurs before a property of the visual is updated. (Inherited from Visual) |
| OnChildAdded | (Overrides VisualOnChildAdded) |
| OnChildRemoved | (Overrides VisualOnChildRemoved) |
| OnClick | Occurs when the visual is clicked on in demonstration/navigation mode. (Inherited from Visual) |
| OnConnected | Occurs when this visual is connected to another visual (Inherited from Visual) |
| OnCustomPropertyCreated | Occurs after a new custom property is added to the visual. (Inherited from Visual) |
| OnCustomPropertyRenamed | Occurs after a custom property of the visual is renamed. (Inherited from Visual) |
| OnCustomPropertyUpdated | Occurs after a custom property of the visual is updated. (Inherited from Visual) |
| OnDisconnected | Occurs when this visual is disconnected from another visual (Inherited from Visual) |
| OnDragEnd | Occurs when a visual has finished being dragged to a new location. (Inherited from Visual) |
| OnDragStart | Occurs when a visual is about to be dragged to a new location. (Inherited from Visual) |
| OnExperimentFinished | Occurs at the end of each experiment. This allows finalization of any data collection, for example. (Inherited from Visual) |
| 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. (Inherited from Visual) |
| OnExperimentStarted | Occurs at the start of each experiment. This allows for initialization of any data collection, for example. (Inherited from Visual) |
| 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. (Inherited from Visual) |
| OnFloorHit | Occurs when a load first contacts the floor. |
| OnInitialize | Occurs when Play is pressed at time 0. (Inherited from Visual) |
| OnKey | Occurs when a key is pressed or released and this visual is selected. (Inherited from Visual) |
| OnKeyPress | Occurs when a key is pressed and this visual is selected. (Inherited from Visual) |
| OnLoaded | Occurs when the document is first opened. |
| OnMessage | Occurs when a message is sent from another visual's MessageListeners list. (Inherited from Visual) |
| OnMouseLeave | Occurs when the mouse moves away from the visual. (Inherited from Visual) |
| OnMouseMove | Occurs when the mouse moves over the visual. (Inherited from Visual) |
| OnMouseOver | Occurs when the mouse enters the visual. (Inherited from Visual) |
| OnMouseUp | Occurs when a mouse button is released after being pressed on the visual. (Inherited from Visual) |
| OnMoved | Occurs when a visual has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit. (Inherited from Visual) |
| OnMoveToCompleted | Occurs when a MoveTo or TurnTo has finished. (Inherited from Visual) |
| OnNameChanged | Occurs when this visual's name is changed. (Inherited from Visual) |
| 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. (Inherited from Visual) |
| OnParentUpdated | Occurs when the parent for the visual changes. (Inherited from Visual) |
| 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. (Inherited from Visual) |
| OnRealtimeLag | Occurs if the document is running and falls behind by RealtimeLag or more. Useful for ensuring Controls Testing is in sync. |
| 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. (Inherited from Visual) |
| OnReset | Occurs when Reset is pressed. (Inherited from Visual) |
| OnShortcut | (Inherited from Visual) |
| OnShowDirections | Occurs when the status of the "Show Direction Arrows" configuration is changed. (Inherited from Visual) |
| OnStart | Occurs when the model starts running after initialize or after it has been stopped/paused. |
| OnStop | Occurs when the model stops running. |
| OnUnloaded | Occurs when the document is closed. |
| OnVisualAdded | Occurs when a visual is added to the scene. |
| OnVisualRemoved | Occurs when a visual is removed from the scene. |
| OptimizeStaticVisuals | When true optimizes all static visuals when exporting Raw3d files or starting a web server. |
| Parent |
The parent Visual for this Visual.
(Inherited from Visual) |
| PasteOffset | 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. |
| PhysicsAutoDisableTimeStep | 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. |
| PhysicsCollisionMargin |
The default collision margin for physics collision geometry belonging to the visual's
PhysicsBody.
(Inherited from Visual) |
| PhysicsEnabled |
Whether the physics for the visual is enabled or not.
(Inherited from Visual) |
| PhysicsEngineAutoMerging | Automatically merge rigid bodies to reduce degrees of freedom (AGX Only). |
| PhysicsEngineDefaultSolver | The default physics constraint solver to use (AGX Only). |
| PhysicsEngineType | 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. |
| PhysicsGridSize | Obsolete |
| PhysicsMaxIterations | Obsolete |
| PhysicsMinIterations | Obsolete |
| PhysicsMode | 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. |
| PhysicsNumBodyIterationScale | Obsolete |
| PhysicsTimeStep | 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. |
| PreferGPU | Whether to prefer the GPU processor for collision detection and constraint solving when running in volumetric physics with PhysX. Note that you must have the PhysX processor set to "GPU" or "Auto" in the NVIDIA Control Panel. |
| 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> (Inherited from Visual) |
| RealtimeLag | Call the OnRealtimeLag script if the running document gets this number of seconds or more behind real time. |
| References | 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 ...\). |
| Reflectivity | The reflectivity of the material. 0 is non-reflective, 100 is a mirror. 10 is a good value for conveyor surfaces. |
| ReportImpulses | Whether to report impulses for collisions when running in volumetric physics with PhysX. Enabling this option can severely impact performance. |
| RotationDegrees |
The rotation of the Visual (in degrees) relative to ts Parent Visual.
(Inherited from Visual) |
| RotationMatrix |
The rotation of this Visual relative to its Parent in Matrix form.
(Inherited from Visual) |
| RotationRadians |
The rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual) |
| RotationXDegrees |
The X rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual) |
| RotationXRadians |
The X rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual) |
| RotationYDegrees |
The Y rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual) |
| RotationYRadians |
The Y rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual) |
| RotationZDegrees |
The Z rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual) |
| RotationZRadians |
The Z rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from 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. (Inherited from Visual) |
| ShowControlPoints |
Whether the control points for this visual should be rendered.
(Inherited from Visual) |
| ShowDefaultFloorInExport | When true show the default floor when exporting Raw3d files or starting a web server. |
| ShowFloor | Turn on/off the drawing of the floor beneath the conveyor sections. |
| ShowGrid | |
| ShowSupports | Turn on/off the drawing of the conveyor support stands. |
| SimpleProperties | Enter a non-empty name for each property that should be shown in the Simple Properties view. (Inherited from Visual) |
| SimulationFallingWarning | Warn if we fall more than SimulationTransferTolerance onto a conveyor |
| SimulationLinearPathCount | A read-only report on the number of linear paths that are in use in the current linear physics simulation. |
| SimulationOverlapTolerance | Maximum load overlap allowed in Simulation |
| SimulationOverlapWarning | Warn if we get loads overlapping by more than SimulationOverlapTolerance in Simulation |
| SimulationSensorTolerance | Maximum distance from a sensor that can trigger an OnBlocked or OnCleared event in Simulation |
| SimulationTransferTolerance | Maximum gap allowed for automatic conveyor to conveyor transfer in Simulation |
| SortConveyorContacts | If enabled then contact points for collisions involving a conveyor are sorted into a clockwise or counterclockwise ordering before being passed to an OnProcessContact event handler. This may be necessary when using certain physics engines with old models or catalog items that were designed with ODE in mind. |
| StopOnError | Stop the model running if an Error is logged. |
| SurfaceArea | (Overrides VisualSurfaceArea) |
| SurfaceAreaDeep |
Surface area of Visual and all its children.
(Inherited from Visual) |
| 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. (Inherited from Visual) |
| ToolTipExpr | The format string for the tooltip that appears for an object. (Inherited from Visual) |
| TopColor | The top color for the project backdrop color gradient. |
| TopParent |
Get the top level visual, the one which has no parent.
(Inherited from Visual) |
| 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).
(Inherited from Visual) |
| TransferStateEnabled |
Whether this visual supports the Transfer Protocol.
This is normally set for transfer enabled equipment (not loads).
(Inherited from Visual) |
| Type |
A type string for the Visual.
(Inherited from 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. (Inherited from Visual) |
| UserVars | A dictionary of user key value pairs that can be used to store any custom data about the visual. (Inherited from Visual) |
| VehiclesCollide | 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. |
| Velocity |
The current linear velocity of the Visual in meters/second.
(Inherited from Visual) |
| VertexCount | (Overrides VisualVertexCount) |
| VertexCountDeep |
Number of vertices in Mesh for Visual and all its children.
(Inherited from Visual) |
| VisualAndAncestors |
Return all ancestor visuals above this point in the Visual hierarchy, including the Visual itself.
(Inherited from Visual) |
| VisualAndDescendants |
Return all visuals below this point in the Visual hierarchy including the Visual itself.
(Inherited from Visual) |
| Volume | (Overrides VisualVolume) |
| VolumeDeep |
Volume of Visual and all its children.
(Inherited from Visual) |
| WorldBoundingBox |
The world axis aligned bounding box of this Visual
including the bounding boxes of all the child visuals and their children.
(Inherited from Visual) |
| WorldBoundingBoxExcludingChildren |
The world axis aligned bounding box of this Visual only (excluding any children).
(Inherited from Visual) |
| WorldBoundingSphere |
Get the bounding sphere of this visual, including its children, in world space relative to the Scene.
(Inherited from Visual) |
| WorldBoundingSphereExcludingChildren |
Get the bounding sphere of this visual, excluding its children, in world space relative to the Scene.
(Inherited from Visual) |
| WorldLocation |
The visual's world X, Y, and Z coordinates relative to the Scene.
(Inherited from Visual) |
| WorldLocationX |
The visual's world X coordinate relative to the Scene.
(Inherited from Visual) |
| WorldLocationY |
The visual's world Y coordinate relative to the Scene.
(Inherited from Visual) |
| WorldLocationZ |
The visual's world Z coordinate relative to the Scene.
(Inherited from Visual) |
| WorldMatrix |
The Location and Rotation of this Visual in Matrix form.
(Inherited from Visual) |
| WorldRotationDegrees |
The world rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual) |
| WorldRotationMatrix |
The rotation of this Visual relative to the Scene in Matrix form.
(Inherited from Visual) |
| WorldRotationRadians |
The world rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual) |
| WorldRotationXDegrees |
The world X rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual) |
| WorldRotationXRadians |
The world X rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual) |
| WorldRotationYDegrees |
The world Y rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual) |
| WorldRotationYRadians |
The world Y rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual) |
| WorldRotationZDegrees |
The world Z rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual) |
| WorldRotationZRadians |
The world Z rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual) |
| WorldXAxis |
The world X-Axis for the visual
(Inherited from Visual) |
| WorldYAxis |
The world Y-Axis for the visual
(Inherited from Visual) |
| WorldZAxis |
The world Z-Axis for the visual
(Inherited from Visual) |
Methods| Name | Description | |
|---|---|---|
 | AddAspect(Object) | (Inherited from CoreVisual) |
 | AddAspectT(T) |
Add an aspect instance.
(Inherited from Visual) |
| AddBindingInterface | Add a custom property to the visual which. This property is set to be a binding interface using the declared access rights. (Inherited from Visual) |
| AddCustomProperty(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) |
| AddCustomProperty(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) |
| AddSimpleProperty(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) |
| AddSimpleProperty(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) |
| AddTemporaryProperty(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) |
| AddTemporaryProperty(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) |
| AddTemporaryProperty(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) |
| AddTemporaryProperty(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) |
| AlignToFloor |
Align the mesh bounding box of the Visual to the default FloorVisual of the Scene.
(Inherited from Visual) |
| AlignToFloor(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) |
| CancelAnimators |
Cancel any animations that are currently in progress.
(Inherited from Visual) |
| ChildrenAsList |
Return a List<Visual> representing all the children of this visual
(Inherited from Visual) |
| Clone |
Create a copy of a visual and its children placed in the
top level scene.
(Inherited from Visual) |
| ConnectedVisual |
Find the visual that is attached to the supplied connectorName.
(Inherited from Visual) |
| ConnectTo(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) |
| ConnectTo(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) |
| Contains |
Is the visual contained by the visual tree from this point down?
(Inherited from Visual) |
| ContainsChild |
Is the child a direct child of the visual.
(Inherited from Visual) |
| CreateManagedAspectT | (Inherited from Visual) |
 | DefaultFactory | |
| Delete |
Delete this visual. If it is in a Document, it is removed from the document as well.
(Inherited from Visual) |
| Disconnect |
Disconnect any connections on the supplied connector name.
(Inherited from Visual) |
| FadeToColor |
Changes the primary color of the visual over a given time.
This method blocks the current script until the transition is complete.
(Inherited from Visual) |
| FadeToColorDeep |
Animate the primary color of a visual and all its descendants in a given time.
(Inherited from Visual) |
| FadeToMultipleColors |
Changes the set of material colors on the visual over a given time.
This method blocks the current script until the transition is complete.
(Inherited from Visual) |
| FadeToTransparency |
Change the transparency of the visual over a given time period.
Note that this may have no effect if the visual has a texture in its material.
(Inherited from Visual) |
| FadeToTransparencyDeep |
Animate the transparency of a visual and all its descendants in a given time.
(Inherited from Visual) |
| FilteredChildren |
Return the collection of child Visuals that match the given predicate.
(Inherited from Visual) |
| FilteredDescendants |
Return all visuals below this point in the Visual hierarchy that match the given predicate.
(Inherited from Visual) |
| FindAncestorsAspectT |
Find the first aspect of type T on one of the visuals ancestors (parent, grand-parent, etc.).
(Inherited from Visual) |
| FindAncestorsAspectsT |
Finds all aspects of type T on any of this visual's ancestors.
(Inherited from Visual) |
| FindAspect(Type) |
Finds and returns an aspect of a given type.
(Inherited from CoreVisual) |
| FindAspectT |
Finds and returns an aspect of a given type.
(Inherited from CoreVisual) |
| FindAspectsT |
Find all aspects that can be cast to the given type.
(Inherited from CoreVisual) |
| FindBindingInterface | Find a binding interface by name if it exists. Otherwise return null. (Inherited from Visual) |
| FindChild |
Look through children and their children to find the first visual of a given name.
Breadth first search.
(Inherited from Visual) |
| FindConnector |
Find a named connector on a conveyor object, e.g. "Start"
(Inherited from Visual) |
| FindCreateAspect(Type) |
Finds an aspect if it exists or Adds a new one if it doesn't exist.
(Inherited from CoreVisual) |
| FindCreateAspectT |
Finds an aspect if it exists or adds a new one if it doesn't exist.
(Inherited from CoreVisual) |
| FindCreateConnector |
Find or create a connector of the supplied name.
(Inherited from Visual) |
| FindCreateManagedAspectT | (Inherited from Visual) |
| FindCustomProperty |
Find a custom property by name if it exists. Otherwise return null.
(Inherited from Visual) |
| FindDotNetType | (Inherited from Visual) |
| FindFirstOfType |
Like FindType except it return the first instance of that type.
(Inherited from Visual) |
| FindImmediateChild |
Look through children to find a named visual.
(Inherited from Visual) |
| FindImmediateChildren |
Look through children to find all immediate children with a given name.
(Inherited from Visual) |
| FindImmediateType |
Find all the objects in the Children of type Type (immediate children only)
(Inherited from Visual) |
| FindManagedAspectsT |
Find all managed aspects that can be cast to the given type.
(Inherited from Visual) |
| FindParent(PredicateVisual) |
Go back up through the parents of visuals to find a particular parent that matches the supplied predicate.
(Inherited from Visual) |
| FindParent(Type) |
Go back up through the parents of visuals to find a particular parent type.
(Inherited from Visual) |
| FindType |
Find all the objects in the Descendants of type Type (all descendants)
(Inherited from Visual) |
| FindVisualAndAncestorsAspectT |
Find the first aspect of type T on this visual or one of its ancestors (parents, grand-parents, etc.).
(Inherited from Visual) |
| FindVisualAndAncestorsAspectsT |
Finds all aspects of type T on this visual or its ancestors.
(Inherited from Visual) |
| FindVisualAndDescendantsAspectT |
Find the first aspect of type T on this visual or one of its descendents (children recursively)
(Inherited from Visual) |
| FindVisualAndDescendantsAspectsT |
Find all aspects of type T on this visual or one of its descendents (children recursively)
(Inherited from Visual) |
| FindVisualType |
Find all the visuals that have their Type field set to 'type'.
(Inherited from Visual) |
| Freeze |
Hold the load in one position by making it kinematic.
(Inherited from Visual) |
| GetCustomProperty |
Get the container class for a custom property, or null if it doesn't exist.
(Inherited from Visual) |
| GetCustomPropertyValue(String) |
Get the value of a custom property, or null if it doesn't exist.
(Inherited from Visual) |
| GetCustomPropertyValueT(String, T) |
Get the value of a custom property, or a defaultValue if it doesn't exist.
(Inherited from Visual) |
| GoToInitialPosition |
Set the Location and Rotation of the Visual to be the same as the InitialLocation and InitialRotation.
(Inherited from Visual) |
| GoToInitialRotation |
Set the Rotation of the Visual to be the same as the InitialRotation. The Location remains unchanged.
(Inherited from Visual) |
| HasAspectT |
Returns whether an aspect of a given type can be found on the visual.
(Inherited from Visual) |
| HasCustomProperty |
Determines whether a custom property has been defined or not.
(Inherited from Visual) |
| InitializeDefault | (Inherited from Visual) |
| IsAncestorOf |
Is this Visual a parent, grandparent, great grandparent etc. of the
potentialChild.
(Inherited from Visual) |
| IsDeleted |
Determine if the Visual been deleted.
(Inherited from Visual) |
| MoveTo(Matrix) |
Move to a new matrix location instantly.
(Inherited from Visual) |
| MoveTo(Vector3) |
Move to a new location instantly.
(Inherited from Visual) |
| MoveTo(Matrix, SpeedProfile) |
Move to a new matrix location using a speed profile.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Matrix, Double) |
Move to a new matrix location at a given speed.
(Inherited from Visual) |
| MoveTo(Vector3, SpeedProfile) |
Move to a new location given a speed profile.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Vector3, Double) |
Move to a new location given a speed.
(Inherited from Visual) |
| MoveTo(Matrix, Double, Double) |
Move to a new matrix location at a given speed and acceleration.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Vector3, Double, Double) |
Move to a new location given a speed and acceleration.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Visual, Matrix, SpeedProfile) |
Move to a new matrix location relative to another visual.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Visual, Matrix, Double) |
Move to a new matrix location relative to another visual.
(Inherited from Visual) |
| MoveTo(Visual, Vector3, SpeedProfile) |
Move to a new location relative to another visual.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Visual, Vector3, Double) |
Move to a new location relative to another visual.
(Inherited from Visual) |
| MoveTo(Matrix, Double, Double, Double) |
Move to a new matrix location at a given speed, acceleration and deceleration.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Vector3, Double, Double, Double) |
Move to a new location given a speed, acceleration, and deceleration.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Visual, Matrix, Double, Double) |
Move to a new matrix location relative to another visual.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Visual, Vector3, Double, Double) |
Move to a new location relative to another visual.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Visual, Matrix, Double, Double, Double) |
Move to a new matrix location relative to another visual.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveTo(Visual, Vector3, Double, Double, Double) |
Move to a new location relative to another visual.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| MoveToInitialPosition |
Move to the InitialPosition and InitialRotation.
(Inherited from Visual) |
 | NotifyMeshChanged | (Inherited from Visual) |
| PopRoutingTarget |
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) |
| PushRoutingTarget |
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) |
| RecalculateConnections |
Attach or detach connectors and accessories to or from valid connections on this visual and all children.
(Inherited from Visual) |
| RemoveAspect(Object) | (Inherited from CoreVisual) |
| RemoveAspect(Type) |
Removes an aspect of a given type.
(Inherited from Visual) |
| RemoveAspectT |
Removes an aspect.
(Inherited from Visual) |
| RemoveAspectT(T) |
Removes an aspect instance.
(Inherited from Visual) |
| RemoveBindingInterface | Add a custom property to the visual. This property is set to be a binding interface using the declared access rights. (Inherited from Visual) |
| RemoveConnector |
Remove a connector with a certain name.
(Inherited from Visual) |
| RemoveCustomProperty |
Remove a custom property from the Visual.
(Inherited from Visual) |
| Reparent |
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.
(Inherited from Visual) |
| Rotate(Axis, SpeedProfile) |
Set the visual rotating.
(Inherited from Visual) |
| Rotate(Axis, Double) |
Set the visual rotating.
(Inherited from Visual) |
| Rotate(Axis, Double, Double) |
Set the visual rotating.
(Inherited from Visual) |
| Rotate(Visual, Axis, SpeedProfile) |
Set the visual rotating.
(Inherited from Visual) |
| Rotate(Visual, Axis, SpeedProfile, RotationDirection) |
Set the visual rotating.
(Inherited from Visual) |
| RotateByImmediate | (Inherited from Visual) |
| RotateToImmediate |
Rotate immediately around a given local axis to a given angle relative to the visual's initial position.
(Inherited from Visual) |
| RotateToLocalX |
Rotate around the local X axis a given amount at a given speed.
(Inherited from Visual) |
| RotateToLocalY |
Rotate around the local Y axis a given amount at a given speed.
(Inherited from Visual) |
| RotateToLocalZ |
Rotate around the local Z axis a given amount at a given speed.
(Inherited from Visual) |
| SetCustomPropertyValueT |
Set the value of a custom property or do nothing if it doesn't exist.
(Inherited from Visual) |
| SetInitialPosition |
Set InitialLocation to be the current Location and InitialRotation to be the current Rotation.
(Inherited from Visual) |
| SetIsStaticDeep |
Set the IsStatic property for this Visual and all children recursively.
(Inherited from Visual) |
| SetNativeObject |
Set the native C# scripting class instance for this visual
(Inherited from Visual) |
| SetScriptNativeTypeName |
Atomically set the Script and NativeTypeName together but only create the NativeObject once.
(Inherited from Visual) |
| Stick |
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) |
| StickKinematic |
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) |
| ToStream |
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) |
| ToXml |
Convert a visual to XML.
Use Document.CreateVisual to turn it back into a copy of the original visual.
(Inherited from Visual) |
| TransformFromWorld |
Transform a world coordinate to a local coordinate
(Inherited from Visual) |
| TransformFromWorldNormal |
Transform a world normal to a local normal
(Inherited from Visual) |
| TransformFromWorldRotationDegrees |
Transform a world rotation (in degrees) to a local rotation (in degrees).
(Inherited from Visual) |
| TransformFromWorldRotationRadians |
Transform a world rotation (in radians) to a local rotation (in radians).
(Inherited from Visual) |
| TransformToParent |
Transform a local coordinate to coordinate local to parent.
(Inherited from Visual) |
| TransformToParentNormal |
Transform a local normal to normal local to parent
(Inherited from Visual) |
| TransformToWorld |
Transform a local coordinate to a world coordinate.
(Inherited from Visual) |
| TransformToWorldNormal |
Transform a local normal to a world normal.
(Inherited from Visual) |
| TransformToWorldRotationDegrees |
Transform a local rotation (in radians) to a world rotation (in radians).
(Inherited from Visual) |
| TransformToWorldRotationRadians |
Transform a local rotation (in radians) to a world rotation (in radians).
(Inherited from Visual) |
| TranslateLocalX(Double) |
Instantly move the visual along the local X axis of its initial matrix by xOffset units.
(Inherited from Visual) |
| TranslateLocalX(Double, Double) |
Move the visual along the local X axis of its initial matrix by xOffset units, at the given speed.
(Inherited from Visual) |
| TranslateLocalX(Double, Double, Double, Double) |
Move the visual along the local X axis of its initial matrix by xOffset units, at the given speed and acceleration
(Inherited from Visual) |
| TranslateLocalY(Double) |
Instantly move the visual along the local Y axis of its initial matrix by yOffset units.
(Inherited from Visual) |
| TranslateLocalY(Double, Double) |
Move the visual along the local Y axis of its initial matrix by yOffset units, at the given speed.
(Inherited from Visual) |
| TranslateLocalY(Double, Double, Double, Double) |
Move the visual along the local Y axis of its initial matrix by yOffset units, at the given speed and acceleration
(Inherited from Visual) |
| TranslateLocalZ(Double) |
Instantly move the visual along the local Z axis of its initial matrix by zOffset units.
(Inherited from Visual) |
| TranslateLocalZ(Double, Double) |
Move the visual along the local Z axis of its initial matrix by zOffset units, at the given speed.
(Inherited from Visual) |
| TranslateLocalZ(Double, Double, Double, Double) |
Move the visual along the local Z axis of its initial matrix by zOffset units, at the given speed and acceleration
(Inherited from Visual) |
| TranslateX(Double) |
Instantly move the visual along the model's X axis by xOffset units
(Inherited from Visual) |
| TranslateX(Double, Double) |
Move the visual along the model's X axis by xOffset units, at the given speed.
(Inherited from Visual) |
| TranslateX(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) |
| TranslateY(Double) |
Instantly move the visual along the model's Y axis by yOffset units
(Inherited from Visual) |
| TranslateY(Double, Double) |
Move the visual along the model's Y axis by yOffset units, at the given speed.
(Inherited from Visual) |
| TranslateY(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) |
| TranslateZ(Double) |
Instantly move the visual along the model's Z axis by zOffset units
(Inherited from Visual) |
| TranslateZ(Double, Double) |
Move the visual along the model's Z axis by zOffset units, at the given speed.
(Inherited from Visual) |
| TranslateZ(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) |
| TurnTo(Matrix) |
Immediate Matrix TurnTo.
(Inherited from Visual) |
| TurnTo(Vector3) |
Turn to a new yaw pitch roll instantly.
(Inherited from Visual) |
| TurnTo(Matrix, SpeedProfile) |
Main Matrix TurnTo method.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Matrix, Double) |
Matrix TurnTo method.
(Inherited from Visual) |
| TurnTo(Vector3, Double) |
Turn to a new yaw pitch roll in a fixed time.
(Inherited from Visual) |
| TurnTo(Axis, Double, SpeedProfile) |
Turns to a target rotation.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Axis, Double, Double) |
Turns to a target rotation.
(Inherited from Visual) |
| TurnTo(Matrix, Double, Double) |
Matrix TurnTo method.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Visual, Matrix, SpeedProfile) |
Main Matrix TurnTo method.
(Inherited from Visual) |
| TurnTo(Visual, Matrix, Double) |
Matrix TurnTo method.
(Inherited from Visual) |
| TurnTo(Axis, Double, SpeedProfile, RotationDirection) |
Turns to a target rotation.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Axis, Double, Double, Double) |
Turns to a target rotation.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Matrix, Double, Double, Double) |
Matrix TurnTo method.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Visual, Axis, Double, SpeedProfile) |
Turns to a target rotation. If the targetVisual is the same as the rotating visual, the target rotation will be away from the visual's initial rotation.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Visual, Axis, Double, Double) |
Turns to a target rotation. If the targetVisual is the same as the rotating visual, the target rotation will be away from the visual's initial rotation.
(Inherited from Visual) |
| TurnTo(Visual, Matrix, Double, Double) |
Matrix TurnTo method.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Axis, Double, Double, Double, Double) |
Turns to a target rotation.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Visual, Axis, Double, SpeedProfile, RotationDirection) |
Turns to a target rotation. If the targetVisual is the same as the rotating visual, the target rotation will be away from the visual's initial rotation.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Visual, Axis, Double, Double, Double) |
Turns to a target rotation. If the targetVisual is the same as the rotating visual, the target rotation will be away from the visual's initial rotation.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Visual, Matrix, Double, Double, Double) |
Matrix TurnTo method.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| TurnTo(Visual, Axis, Double, Double, Double, Double) |
Turns to a target rotation. If the targetVisual is the same as the rotating visual, the target rotation will be away from the visual's initial rotation.
An acceleration or deceleration of zero is handled as infinity, meaning the top speed is instantly reached, and movement is immediately stopped respectively.
(Inherited from Visual) |
| Unfreeze |
Release the load in one position by making it dynamic.
(Inherited from Visual) |
| Unstick |
Reparents this (stuck) visual to the scene and restores its physics state.
(Inherited from Visual) |
| WaitForAnimator | (Inherited from Visual) |
| WakeUpSurroundingVisuals |
Wake up any surrounding loads that might have been disabled so they don't remain in midair.
(Inherited from Visual) |
Events| Name | Description | |
|---|---|---|
 | AspectRemoved |
Raised when an aspect is removed from this Visual.
(Inherited from Visual) |
| ControlPointEndDragListeners |
Occurs when a ControlPoint drag operation is completed.
(Inherited from Visual) |
| ControlPointStartDragListeners |
Occurs when a ControlPoint drag operation is started.
(Inherited from Visual) |
| DeletedListeners |
Occurs when the visual is deleted (Delete).
(Inherited from Visual) |
| InitializeListeners |
Occurs when the visual is initialized (OnInitialize).
(Inherited from Visual) |
| MeshChanged |
Occurs when the mesh of the visual is changed.
(Inherited from Visual) |
| ResetListeners |
Occurs when the visual is reset (OnReset).
(Inherited from Visual) |
Fields| Name | Description | |
|---|---|---|
 | OnProcessCleared | (Inherited from Visual) |
| OnProcessCollision | (Inherited from Visual) |
| OnReportCollisionImpulse | (Inherited from Visual) |
Extension Methods| Name | Description | |
|---|---|---|
 | FullPropertyPath | (Defined by PathExtensions) |
See Also