Click or drag to resize

SceneVisual Properties

The SceneVisual type exposes the following members.

Properties
 NameDescription
Public propertyAlignOffsetAdd 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.
Public propertyAllAspects Returns all the aspects for this Visual.
(Inherited from CoreVisual)
Public propertyAllConnectorsGets all connectors.
(Inherited from Visual)
Public propertyAllowTeleportOnDefaultFloorInExportWhen true allow teleporting on to the default floor in exported Raw3d files or web servers.
Public propertyAllowUndefinedFrictionIf 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.
Public propertyAllowWaitOnMoveWhen true, allows scripting to wait for the OnMoved event. This is false by default to avoid performance degradation for visuals that move frequently. <p> Example scripting: <pre> sender.AllowWaitOnMove = true; Wait( sender.OnMoved ); </pre>
(Inherited from Visual)
Public propertyAmbientIntensityLinearly scales the intensity of the ambient light. Can be used to brighten/darken the shadows of objects.
Public propertyAmbientLightThe color of ambient light that permeates throughout the scene. Can be used to brighten/darken the shadows of objects.
Public propertyAmbientSourceTypeWhere 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.
Public propertyAnalysisUpdateIntervalHow often the Analysis spreadsheet should be updated if there are pending changes to it and it's visible (in seconds).
Public propertyAncestors Return all ancestor visuals above this point in the Visual hierarchy.
(Inherited from Visual)
Public propertyAngularVelocity The current angular velocity of the Visual in radians/second.
(Inherited from Visual)
Public propertyAnimatorInProgress Determine if any animations are currently in progress for this Visual.
(Inherited from Visual)
Public propertyApp The global application object.
(Inherited from Visual)
Public propertyAutoSizeAutomatically resize the floor to fit what is on it.
Public propertyBillboardIf true, then the visual will always face the camera. This is useful for text that should always face the user, for example. <p> Note that the visual's Rotation property will be set automatically, and so will overwrite any updates made from scripting or from the property grid.
(Inherited from Visual)
Public propertyBillOfMaterialsCodeExprThe catalog order code of the component as it appears in the bill of materials, e.g. "'XYZ-203-37.TZ1'". If this is blank there will be no entry in the bill of materials for this component.
(Inherited from Visual)
Public propertyBillOfMaterialsCostExprThe cost of the component as it appears in the bill of materials, e.g. "1595.95".
(Inherited from Visual)
Public propertyBillOfMaterialsDescriptionExprThe description of the component as it appears in the bill of materials, e.g. "Driven Roller Module". If this is blank there will be no entry in the bill of materials for this component.
(Inherited from Visual)
Public propertyBottomColorThe bottom color for the project backdrop color gradient.
Public propertyBoundingBox Get the bounding box of this visual including all its children.
(Inherited from Visual)
Public propertyBoundingBoxExcludingChildren
(Overrides VisualBoundingBoxExcludingChildren)
Public propertyBoundingSphere Get the bounding sphere of this visual, including its children.
(Inherited from Visual)
Public propertyBoundingSphereExcludingChildren
(Overrides VisualBoundingSphereExcludingChildren)
Public propertyCameraThe 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.
Public propertyCCD 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.
Public propertyChildren Return the collection of child Visuals.
(Inherited from Visual)
Public propertyClientOwnerUsername
(Inherited from Visual)
Public propertyConnectAllowedA list of visual Types that are allowed to connect to this visual. If empty, then all visuals are allowed to connect, provided they are not specified in the ConnectDisallowed list, and that the connector-specific rules also allow the connection. <p> See also: <ul> <li>Demo3D.Visuals.Visual.ConnectDisallowed <li>Demo3D.Visuals.Connector.Allowed <li>Demo3D.Visuals.Connector.Disallowed </ul>
(Inherited from Visual)
Public propertyConnectDisallowedA list of visual Types that are not allowed to connect to this visual. If a Type appears in both ConnectAllowed and ConnectDisallowed, then ConnectDisallowed takes priority and the connection is not allowed. <p> See also: <ul> <li>Demo3D.Visuals.Visual.ConnectAllowed <li>Demo3D.Visuals.Connector.Allowed <li>Demo3D.Visuals.Connector.Disallowed </ul>
(Inherited from Visual)
Public propertyConnectOnInitializeWhether to automatically connect to any tag servers when the document is initialized.
Public propertyConnectOnLoadWhether to automatically connect to any tag servers when the document is loaded.
Public propertyConnectorPairs All pairs of connectors from this visual.
(Inherited from Visual)
Public propertyControlPointsAllowedA white list of control points that should be shown and editable.
(Inherited from Visual)
Public propertyControlPointsDisallowedA black list of control points that should be hidden and not editable.
(Inherited from Visual)
Public propertyCurrentRoutingTarget The current destination for this visual (usually a load). This can be used by equipment to decide which direction to transfer a load, or it can be ignored. It is specific to the equipment processing the load.
(Inherited from Visual)
Public propertyCurrentStation The Visual that the load is current at waiting to be ordered. Any Visual can be a Station but LoadCreatorVisual the first station set when calling LoadCreatorVisual.OrderLoad(). This is normally set for loads.
(Inherited from Visual)
Public propertyCurrentTransfer Information about the current transfer in progress for this visual using the Transfer Protocol. This is normally set for loads.
(Inherited from Visual)
Public propertyCustomProperties The collection of CustomProperty objects for this Visual.
(Inherited from Visual)
Public propertyDefaultFloorWhen 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.
Public propertyDeleteLoadsAfterWhen a load hits the floor it will automatically be deleted after this number of seconds provided its 'Delete When Floor Hit' flag is set
Public propertyDescendants Return all visuals below this point in the Visual hierarchy .
(Inherited from Visual)
Public propertyDescendantsDepthFirst Return all visuals below this point in the Visual hierarchy .
(Inherited from Visual)
Public propertyDescription A description of the Visual.
(Inherited from Visual)
Public propertyDirectionArrowOffsetThe 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).
Public propertyDocument The document that this Visual belongs to.
(Inherited from Visual)
Public propertyDraggable Whether the visual be dragged using the mouse.
(Inherited from Visual)
Public propertyEventLogPathA 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.
Public propertyEventTimeStepWhen 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.
Public propertyFaceCount
(Overrides VisualFaceCount)
Public propertyFaceCountDeep Number of faces in Mesh for Visual and all its children.
(Inherited from Visual)
Public propertyFirstChild The first child visual of this visual, or null if this visual has no children.
(Inherited from Visual)
Public propertyFixToParentFor a load or vehicle this will create a fixed joint between it and its parent unless there is another joint in the way. This should be true for creating composite loads or vehicles or false where there is just a logical connection to the parent, e.g. boxes in a tote.
(Inherited from Visual)
Public propertyFloorMaximumSizeThe maximum size the floor can expand to in X or Z.
Public propertyFloorMinimumSizeSize of the floor in an empty model.
Public propertyFloorPhysicsEnabledWhether physics should be enabled for the floor. Disabling this will allow rigid bodies to fall through the floor.
Public propertyFloorTextureNameThe path name of the texture file for the scene floor.
Public propertyFloorTileSizeThe width/length of the floor tile texture in model space.
Public propertyFloorYThe height of the scene floor.
Public propertyFogColorThe color to use for fogging. This represents the color that the scene will blend to at the rear of the scene.
Public propertyFogDensityThe rate with which the fog color will appear. A high number will fog the scene quickly and a low number gradually.
Public propertyFogEnabledEnable the fogging for the scene.
Public propertyFrictionConfigurationA 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.
Public propertyFrictionMaterialThe friction material for the scene floor.
Public propertyFullName The full name of this Visual, including the names of all Parent Visual separated by '.' characters.
(Inherited from Visual)
Public propertyGeneratorOrderThe 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.
Public propertyGeneratorSeedIncrementThis is the increment to the InitialSeed that each individual random number generator is given OnInitialize.
Public propertyGeneratorTypeThe pseudo random number generator algorithm to use. This defaults to Mersenne Twister (MT19937).
Public propertyGridOriginThe origin for the scene grid.
Public propertyGridTextureNameThe path name of the texture file for the scene floor when in build mode.
Public propertyGridTileSizeThe width/length of the grid tile texture in model space.
Public propertyHasChildren Determine if this Visual has any children or not.
(Inherited from Visual)
Public propertyHasNextSibling Determine if this Visual has any siblings or not.
(Inherited from Visual)
Public propertyHideAdvancedProperties
(Inherited from Visual)
Public propertyHierarchyColorThe background color of the Visual in the hierarchy
(Inherited from Visual)
Public propertyId A unique identifier for this Visual.
(Inherited from Visual)
Public propertyIncludeChildContextMenusWhen right clicking on the object should child objects menu items be included. Default is false.
(Inherited from Visual)
Public propertyInitialLocation The InitialLocation of the Visual in meters from the Origin of the Parent Visual.
(Inherited from Visual)
Public propertyInitialMatrix The InitialLocation and InitialRotation in Matrix form.
(Inherited from Visual)
Public propertyInitialParentOnResetThe parent that should be assigned upon reset. This is useful for vehicle-type components that should reset their position to a particular track section, for example. Note this is only applied if InitialPositionOnReset is set to True.
(Inherited from Visual)
Public propertyInitialPositionOnResetMoves the visual back to its initial location and rotation when Reset is pressed.
(Inherited from Visual)
Public propertyInitialRotationDegrees The InitialRotation of the Visual in degrees relative to the Rotation of Parent Visual.
(Inherited from Visual)
Public propertyInitialRotationMatrix The InitialRotation in Matrix form.
(Inherited from Visual)
Public propertyInitialRotationRadians The InitialRotation of the Visual in radians relative to the Rotation of Parent Visual.
(Inherited from Visual)
Public propertyInitialSeedOn load or reset the random number seed for the demonstration will be set to this number. Change this to produce a different demonstration.
Public propertyInitialWorldLocation The InitialLocation of this Visual and all its Parent Visuals in Matrix form.
(Inherited from Visual)
Public propertyInitialWorldMatrix The InitialLocation and InitialRotation of this Visual and all its Parent Visuals in Matrix form.
(Inherited from Visual)
Public propertyIsHttpListeningObsolete
Public propertyIsSimulationTransferInProgress
(Inherited from Visual)
Public propertyIsStatic Can this visual change its Location/Rotation relative to its parent at runtime. This is used to improve simulation and graphical performance by analyzing what can and can't move during a model run.
(Inherited from Visual)
Public propertyIsVisible Determines whether the Visual is currently visible given the state of layers, etc.
(Inherited from Visual)
Public propertyIsWorldStatic Whether this visual and all its ancestor visuals are Static.
(Inherited from Visual)
Public propertyKinematic Whether the visual's body is kinematic.
(Inherited from Visual)
Public propertyLayerThe layer for this object. If (As Parent) it inherits its layer from its parent, which may in turn inherit the layer from its parent, etc.
(Inherited from Visual)
Public propertyLoadsCollideIf 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.
Public propertyLocation The visual's X, Y, and Z coordinates relative to its parent.
(Inherited from Visual)
Public propertyLocationX The visual's X coordinate relative to its parent.
(Inherited from Visual)
Public propertyLocationY The visual's Y coordinate relative to its parent.
(Inherited from Visual)
Public propertyLocationZ The visual's Z coordinate relative to its parent.
(Inherited from Visual)
Public propertyMatrix The current matrix transform of the Visual local to its Parent Visual.
(Inherited from Visual)
Public propertyMechanismsTimeStepThe discrete amount of time between advancing and solving mechanisms.
Public propertyMeshBoundingBox
(Overrides VisualMeshBoundingBox)
Public propertyMeshBoundingSphere
(Overrides VisualMeshBoundingSphere)
Public propertyMoveToEventsEnabledIf True, then MoveTo, TurnTo will issue events that indicate when the visual has started accelerating, cruising, decelerating and has stopped. <p> When enabled, the events are issued as OnAnimatorEvent. <p>An example function that will handle these events is: <pre> function Box_OnAnimatorEvent( sender : Visual, args : AnimatorEventArgs ) { switch (args.EventType) { case AnimatorEventType.Accelerate: print("Accelerating"); break; case AnimatorEventType.Cruise: print("Cruising"); break; case AnimatorEventType.Decelerate: print("Decelerating"); break; case AnimatorEventType.Stop: print("Stopped"); break; } } </pre>
(Inherited from Visual)
Public propertyName The name of the Visual.
(Inherited from Visual)
Public propertyNativeObject The native C# scripting class instance for this visual
(Inherited from Visual)
Public propertyNativeTypeNameThe namespace and class name to instantiate for this Visual, e.g. Demo3D.Components.Component (in this case Demo3D.Components.dll will be loaded to try to find the class)
(Inherited from Visual)
Public propertyNewNameExprThe string used to format the new name of this component if it is copied or added to the project from a catalog. The variable name "ID" will generate a unique number for that type of component in the current project.
(Inherited from Visual)
Public propertyNextSibling The next sibling of this visual, or null if this visual has no siblings.
(Inherited from Visual)
Public propertyOnAfterParentPropertyUpdatedOccurs after a property of the parent visual is updated.
(Inherited from Visual)
Public propertyOnAfterPropertyUpdatedOccurs after a property of the visual is updated.
(Inherited from Visual)
Public propertyOnAfterSubscribedPropertyUpdatedOccurs after a property of a visual that has this visual in its PropertyUpdatedSubscribers list is updated.
(Inherited from Visual)
Public propertyOnAnimatorCompletedOccurs when an animator completes.
(Inherited from Visual)
Public propertyOnAnimatorEventOccurs when the visual starts to accelerate, cruise, decelerate and stop during a MoveTo or TurnTo command. Note that this event will only be issued if MoveToEventsEnabled is set to True.
(Inherited from Visual)
Public propertyOnAspectRenamedOccurs after an aspect on the visual is renamed.
(Inherited from Visual)
Public propertyOnBeforeParentPropertyUpdatedOccurs before a property of the parent visual is updated.
(Inherited from Visual)
Public propertyOnBeforePropertyUpdatedOccurs before a property of the visual is updated.
(Inherited from Visual)
Public propertyOnChildAdded
(Overrides VisualOnChildAdded)
Public propertyOnChildRemoved
(Overrides VisualOnChildRemoved)
Public propertyOnClickOccurs when the visual is clicked on in demonstration/navigation mode.
(Inherited from Visual)
Public propertyOnConnectedOccurs when this visual is connected to another visual
(Inherited from Visual)
Public propertyOnCustomPropertyCreatedOccurs after a new custom property is added to the visual.
(Inherited from Visual)
Public propertyOnCustomPropertyRenamedOccurs after a custom property of the visual is renamed.
(Inherited from Visual)
Public propertyOnCustomPropertyUpdatedOccurs after a custom property of the visual is updated.
(Inherited from Visual)
Public propertyOnDisconnectedOccurs when this visual is disconnected from another visual
(Inherited from Visual)
Public propertyOnDragEndOccurs when a visual has finished being dragged to a new location.
(Inherited from Visual)
Public propertyOnDragStartOccurs when a visual is about to be dragged to a new location.
(Inherited from Visual)
Public propertyOnExperimentFinishedOccurs at the end of each experiment. This allows finalization of any data collection, for example.
(Inherited from Visual)
Public propertyOnExperimentPreInitializeOccurs at the before each experiment starts running but after the current experiment row variables have been set. This allows initialization of the model to be done before OnInitialize has been called.
(Inherited from Visual)
Public propertyOnExperimentStartedOccurs at the start of each experiment. This allows for initialization of any data collection, for example.
(Inherited from Visual)
Public propertyOnExportBindableItemOccurs when Export is called from the Tag Browser. This allows custom information to be written about each tag in addition to the default data.
(Inherited from Visual)
Public propertyOnFloorHitOccurs when a load first contacts the floor.
Public propertyOnInitializeOccurs when Play is pressed at time 0.
(Inherited from Visual)
Public propertyOnKeyOccurs when a key is pressed or released and this visual is selected.
(Inherited from Visual)
Public propertyOnKeyPressOccurs when a key is pressed and this visual is selected.
(Inherited from Visual)
Public propertyOnLoadedOccurs when the document is first opened.
Public propertyOnMessageOccurs when a message is sent from another visual's MessageListeners list.
(Inherited from Visual)
Public propertyOnMouseLeaveOccurs when the mouse moves away from the visual.
(Inherited from Visual)
Public propertyOnMouseMoveOccurs when the mouse moves over the visual.
(Inherited from Visual)
Public propertyOnMouseOverOccurs when the mouse enters the visual.
(Inherited from Visual)
Public propertyOnMouseUpOccurs when a mouse button is released after being pressed on the visual.
(Inherited from Visual)
Public propertyOnMovedOccurs when a visual has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit.
(Inherited from Visual)
Public propertyOnMoveToCompletedOccurs when a MoveTo or TurnTo has finished.
(Inherited from Visual)
Public propertyOnNameChangedOccurs when this visual's name is changed.
(Inherited from Visual)
Public propertyOnParentMovedOccurs when a parent or parent's parent, etc. has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit.
(Inherited from Visual)
Public propertyOnParentUpdatedOccurs when the parent for the visual changes.
(Inherited from Visual)
Public propertyOnPreInitializeOccurs before OnInitialize is called. The OnPreInitialize is called for every visual in one pass. Then a second pass calls OnInitialize for every visual.
(Inherited from Visual)
Public propertyOnRealtimeLagOccurs if the document is running and falls behind by RealtimeLag or more. Useful for ensuring Controls Testing is in sync.
Public propertyOnRenderTypeOccurs whenever the render status of a visual type is changed. This is usually in response to the user pressing one of the "Show X" buttons on the toolbar; for example, "Show Lights", "Show Support Stands", etc.
(Inherited from Visual)
Public propertyOnResetOccurs when Reset is pressed.
(Inherited from Visual)
Public propertyOnShortcut
(Inherited from Visual)
Public propertyOnShowDirectionsOccurs when the status of the "Show Direction Arrows" configuration is changed.
(Inherited from Visual)
Public propertyOnStartOccurs when the model starts running after initialize or after it has been stopped/paused.
Public propertyOnStopOccurs when the model stops running.
Public propertyOnUnloadedOccurs when the document is closed.
Public propertyOnVisualAddedOccurs when a visual is added to the scene.
Public propertyOnVisualRemovedOccurs when a visual is removed from the scene.
Public propertyOptimizeStaticVisualsWhen true optimizes all static visuals when exporting Raw3d files or starting a web server.
Public propertyParent The parent Visual for this Visual.
(Inherited from Visual)
Public propertyPasteOffsetAdd this to the location of the last pasted object. Can be used to replicate a conveyor or other object multiple times with equal spacing.
Public propertyPhysicsAutoDisableTimeStepThe 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.
Public propertyPhysicsCollisionMargin The default collision margin for physics collision geometry belonging to the visual's PhysicsBody.
(Inherited from Visual)
Public propertyPhysicsEnabled Whether the physics for the visual is enabled or not.
(Inherited from Visual)
Public propertyPhysicsEngineAutoMergingAutomatically merge rigid bodies to reduce degrees of freedom (AGX Only).
Public propertyPhysicsEngineDefaultSolverThe default physics constraint solver to use (AGX Only).
Public propertyPhysicsEngineTypeThe 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.
Public propertyPhysicsGridSizeObsolete
Public propertyPhysicsMaxIterationsObsolete
Public propertyPhysicsMinIterationsObsolete
Public propertyPhysicsMode 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.
Public propertyPhysicsNumBodyIterationScaleObsolete
Public propertyPhysicsTimeStepThe 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.
Public propertyPreferGPU 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.
Public propertyPropertyUpdatedSubscribersVisuals that will be notified when any custom property on this visual is updated. Each visual will be notified via its "OnAfterSubscribedPropertyUpdated" script. <p> See also: <ul> <li>OnAfterSubscribedPropertyUpdated </ul>
(Inherited from Visual)
Public propertyRealtimeLagCall the OnRealtimeLag script if the running document gets this number of seconds or more behind real time.
Public propertyReferencesThe 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 ...\).
Public propertyReflectivityThe reflectivity of the material. 0 is non-reflective, 100 is a mirror. 10 is a good value for conveyor surfaces.
Public propertyReportImpulses Whether to report impulses for collisions when running in volumetric physics with PhysX. Enabling this option can severely impact performance.
Public propertyRotationDegrees The rotation of the Visual (in degrees) relative to ts Parent Visual.
(Inherited from Visual)
Public propertyRotationMatrix The rotation of this Visual relative to its Parent in Matrix form.
(Inherited from Visual)
Public propertyRotationRadians The rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual)
Public propertyRotationXDegrees The X rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual)
Public propertyRotationXRadians The X rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual)
Public propertyRotationYDegrees The Y rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual)
Public propertyRotationYRadians The Y rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual)
Public propertyRotationZDegrees The Z rotation of the Visual (in degrees) relative to its Parent Visual.
(Inherited from Visual)
Public propertyRotationZRadians The Z rotation of the Visual (in radians) relative to its Parent Visual.
(Inherited from Visual)
Public propertySelectParentWhenPickedIf this component is clicked on or is included in a selection rectangle then the parent is selected instead and its properties are shown instead. Once this is set the properties can only be changed from the Project Explorer Window.
(Inherited from Visual)
Public propertyShowControlPoints Whether the control points for this visual should be rendered.
(Inherited from Visual)
Public propertyShowDefaultFloorInExportWhen true show the default floor when exporting Raw3d files or starting a web server.
Public propertyShowFloorTurn on/off the drawing of the floor beneath the conveyor sections.
Public propertyShowGrid 
Public propertyShowSupportsTurn on/off the drawing of the conveyor support stands.
Public propertySimplePropertiesEnter a non-empty name for each property that should be shown in the Simple Properties view.
(Inherited from Visual)
Public propertySimulationFallingWarningWarn if we fall more than SimulationTransferTolerance onto a conveyor
Public propertySimulationLinearPathCountA read-only report on the number of linear paths that are in use in the current linear physics simulation.
Public propertySimulationOverlapToleranceMaximum load overlap allowed in Simulation
Public propertySimulationOverlapWarningWarn if we get loads overlapping by more than SimulationOverlapTolerance in Simulation
Public propertySimulationSensorToleranceMaximum distance from a sensor that can trigger an OnBlocked or OnCleared event in Simulation
Public propertySimulationTransferToleranceMaximum gap allowed for automatic conveyor to conveyor transfer in Simulation
Public propertySortConveyorContacts 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.
Public propertyStopOnErrorStop the model running if an Error is logged.
Public propertySurfaceArea
(Overrides VisualSurfaceArea)
Public propertySurfaceAreaDeep Surface area of Visual and all its children.
(Inherited from Visual)
Public propertyTagsList of names that can be used to provide multiple categories of components in a catalog. The catalog can show only components with tag "Pallets", for example.
(Inherited from Visual)
Public propertyToolTipExprThe format string for the tooltip that appears for an object.
(Inherited from Visual)
Public propertyTopColorThe top color for the project backdrop color gradient.
Public propertyTopParent Get the top level visual, the one which has no parent.
(Inherited from Visual)
Public propertyTransferState The current state of transfers in or out of this visual using the Transfer Protocol. This is normally set for transfer enabled equipment (not loads).
(Inherited from Visual)
Public propertyTransferStateEnabled Whether this visual supports the Transfer Protocol. This is normally set for transfer enabled equipment (not loads).
(Inherited from Visual)
Public propertyType A type string for the Visual.
(Inherited from Visual)
Public propertyUserDataA string that can be used to store any custom data about the visual. This is passed to the WebGL and VR renderers to be used in remote applications.
(Inherited from Visual)
Public propertyUserVarsA dictionary of user key value pairs that can be used to store any custom data about the visual.
(Inherited from Visual)
Public propertyVehiclesCollideIf 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.
Public propertyVelocity The current linear velocity of the Visual in meters/second.
(Inherited from Visual)
Public propertyVertexCount
(Overrides VisualVertexCount)
Public propertyVertexCountDeep Number of vertices in Mesh for Visual and all its children.
(Inherited from Visual)
Public propertyVisualAndAncestors Return all ancestor visuals above this point in the Visual hierarchy, including the Visual itself.
(Inherited from Visual)
Public propertyVisualAndDescendants Return all visuals below this point in the Visual hierarchy including the Visual itself.
(Inherited from Visual)
Public propertyVolume
(Overrides VisualVolume)
Public propertyVolumeDeep Volume of Visual and all its children.
(Inherited from Visual)
Public propertyWorldBoundingBox The world axis aligned bounding box of this Visual including the bounding boxes of all the child visuals and their children.
(Inherited from Visual)
Public propertyWorldBoundingBoxExcludingChildren The world axis aligned bounding box of this Visual only (excluding any children).
(Inherited from Visual)
Public propertyWorldBoundingSphere Get the bounding sphere of this visual, including its children, in world space relative to the Scene.
(Inherited from Visual)
Public propertyWorldBoundingSphereExcludingChildren Get the bounding sphere of this visual, excluding its children, in world space relative to the Scene.
(Inherited from Visual)
Public propertyWorldLocation The visual's world X, Y, and Z coordinates relative to the Scene.
(Inherited from Visual)
Public propertyWorldLocationX The visual's world X coordinate relative to the Scene.
(Inherited from Visual)
Public propertyWorldLocationY The visual's world Y coordinate relative to the Scene.
(Inherited from Visual)
Public propertyWorldLocationZ The visual's world Z coordinate relative to the Scene.
(Inherited from Visual)
Public propertyWorldMatrix The Location and Rotation of this Visual in Matrix form.
(Inherited from Visual)
Public propertyWorldRotationDegrees The world rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual)
Public propertyWorldRotationMatrix The rotation of this Visual relative to the Scene in Matrix form.
(Inherited from Visual)
Public propertyWorldRotationRadians The world rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual)
Public propertyWorldRotationXDegrees The world X rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual)
Public propertyWorldRotationXRadians The world X rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual)
Public propertyWorldRotationYDegrees The world Y rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual)
Public propertyWorldRotationYRadians The world Y rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual)
Public propertyWorldRotationZDegrees The world Z rotation of the Visual (in degrees) relative to the Scene.
(Inherited from Visual)
Public propertyWorldRotationZRadians The world Z rotation of the Visual (in radians) relative to the Scene.
(Inherited from Visual)
Public propertyWorldXAxis The world X-Axis for the visual
(Inherited from Visual)
Public propertyWorldYAxis The world Y-Axis for the visual
(Inherited from Visual)
Public propertyWorldZAxis The world Z-Axis for the visual
(Inherited from Visual)
Top
See Also