Visual Methods |
The Visual type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AddAspect(Object) | Adds an aspect instance created outside the Visual. |
| AddAspectT(T) | Add an aspect instance. |
| AddBindingInterface | Add a custom property to the visual which. This property is set to be a binding interface using the declared access rights. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| AlignToFloor | Align the mesh bounding box of the Visual to the default FloorVisual of the Scene. |
| 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. |
| CancelAnimators | Cancel any animations that are currently in progress. |
| ChildrenAsList | Return a List<Visual> representing all the children of this visual |
| Clone | Create a copy of a visual and its children placed in the top level scene. |
| ConnectedVisual | Find the visual that is attached to the supplied connectorName. |
| 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. |
| 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. |
| Contains | Is the visual contained by the visual tree from this point down? |
| ContainsChild | Is the child a direct child of the visual. |
| CreateManagedAspectT | |
| Delete | Delete this visual. If it is in a Document, it is removed from the document as well. |
| Disconnect | Disconnect any connections on the supplied connector name. |
| FadeToColor | Changes the primary color of the visual over a given time. This method blocks the current script until the transition is complete. |
| FadeToColorDeep | Animate the primary color of a visual and all its descendants in a given time. |
| 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. |
| 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. |
| FadeToTransparencyDeep | Animate the transparency of a visual and all its descendants in a given time. |
| FilteredChildren | Return the collection of child Visuals that match the given predicate. |
| FilteredDescendants | Return all visuals below this point in the Visual hierarchy that match the given predicate. |
| FindAncestorsAspectT | Find the first aspect of type T on one of the visuals ancestors (parent, grand-parent, etc.). |
| FindAncestorsAspectsT | Finds all aspects of type T on any of this visual's ancestors. |
| FindAspectsT | Find all aspects that can be cast to the given type. |
| FindBindingInterface | Find a binding interface by name if it exists. Otherwise return null. |
| FindChild | Look through children and their children to find the first visual of a given name. Breadth first search. |
| FindConnector | Find a named connector on a conveyor object, e.g. "Start" |
| FindCreateAspect(Type) | Finds an aspect if it exists or Adds a new one if it doesn't exist. |
| FindCreateAspectT | Finds an aspect if it exists or adds a new one if it doesn't exist. |
| FindCreateConnector | Find or create a connector of the supplied name. |
| FindCreateManagedAspectT | |
| FindCustomProperty | Find a custom property by name if it exists. Otherwise return null. |
| FindDotNetType | |
| FindFirstOfType | Like FindType except it return the first instance of that type. |
| FindImmediateChild | Look through children to find a named visual. |
| FindImmediateChildren | Look through children to find all immediate children with a given name. |
| FindImmediateType | Find all the objects in the Children of type Type (immediate children only) |
| FindManagedAspectsT | Find all managed aspects that can be cast to the given type. |
| FindParent(PredicateVisual) | Go back up through the parents of visuals to find a particular parent that matches the supplied predicate. |
| FindParent(Type) | Go back up through the parents of visuals to find a particular parent type. |
| FindType | Find all the objects in the Descendants of type Type (all descendants) |
| FindVisualAndAncestorsAspectT | Find the first aspect of type T on this visual or one of its ancestors (parents, grand-parents, etc.). |
| FindVisualAndAncestorsAspectsT | Finds all aspects of type T on this visual or its ancestors. |
| FindVisualAndDescendantsAspectT | Find the first aspect of type T on this visual or one of its descendents (children recursively) |
| FindVisualAndDescendantsAspectsT | Find all aspects of type T on this visual or one of its descendents (children recursively) |
| FindVisualType | Find all the visuals that have their Type field set to 'type'. |
| Freeze | Hold the load in one position by making it kinematic. |
| GetCustomProperty | Get the container class for a custom property, or null if it doesn't exist. |
| GetCustomPropertyValue(String) | Get the value of a custom property, or null if it doesn't exist. |
| GetCustomPropertyValueT(String, T) | Get the value of a custom property, or a defaultValue if it doesn't exist. |
| GoToInitialPosition | Set the Location and Rotation of the Visual to be the same as the InitialLocation and InitialRotation. |
| GoToInitialRotation | Set the Rotation of the Visual to be the same as the InitialRotation. The Location remains unchanged. |
| HasAspectT | Returns whether an aspect of a given type can be found on the visual. |
| HasCustomProperty | Determines whether a custom property has been defined or not. |
| InitializeDefault | |
| IsAncestorOf | Is this Visual a parent, grandparent, great grandparent etc. of the potentialChild. |
| IsDeleted | Determine if the Visual been deleted. |
| MoveTo(Matrix) | Move to a new matrix location instantly. |
| MoveTo(Vector3) | Move to a new location instantly. |
| 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. |
| MoveTo(Matrix, Double) | Move to a new matrix location at a given speed. |
| 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. |
| MoveTo(Vector3, Double) | Move to a new location given a speed. |
| 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. |
| 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. |
| 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. |
| MoveTo(Visual, Matrix, Double) | Move to a new matrix location relative to another 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. |
| MoveTo(Visual, Vector3, Double) | Move to a new location relative to another 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| MoveToInitialPosition | Move to the InitialPosition and InitialRotation. |
 | NotifyMeshChanged | |
| 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". |
| 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. |
| RecalculateConnections | Attach or detach connectors and accessories to or from valid connections on this visual and all children. |
| RemoveAspect(Object) | Removes an aspect instance. |
| RemoveAspect(Type) | Removes an aspect of a given type. |
| RemoveAspectT | Removes an aspect. |
| RemoveAspectT(T) | Removes an aspect instance. |
| RemoveBindingInterface | Add a custom property to the visual. This property is set to be a binding interface using the declared access rights. |
| RemoveConnector | Remove a connector with a certain name. |
| RemoveCustomProperty | Remove a custom property from the 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. |
| Rotate(Axis, SpeedProfile) | Set the visual rotating. |
| Rotate(Axis, Double) | Set the visual rotating. |
| Rotate(Axis, Double, Double) | Set the visual rotating. |
| Rotate(Visual, Axis, SpeedProfile) | Set the visual rotating. |
| Rotate(Visual, Axis, SpeedProfile, RotationDirection) | Set the visual rotating. |
| RotateByImmediate | |
| RotateToImmediate | Rotate immediately around a given local axis to a given angle relative to the visual's initial position. |
| RotateToLocalX | Rotate around the local X axis a given amount at a given speed. |
| RotateToLocalY | Rotate around the local Y axis a given amount at a given speed. |
| RotateToLocalZ | Rotate around the local Z axis a given amount at a given speed. |
| SetCustomPropertyValueT | Set the value of a custom property or do nothing if it doesn't exist. |
| SetInitialPosition | Set InitialLocation to be the current Location and InitialRotation to be the current Rotation. |
| SetIsStaticDeep | Set the IsStatic property for this Visual and all children recursively. |
| SetNativeObject | Set the native C# scripting class instance for this visual |
| SetScriptNativeTypeName | Atomically set the Script and NativeTypeName together but only create the NativeObject once. |
| 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. |
| 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. |
| ToStream | Convert a visual to a stream containing XML. Use Document.CreateVisual to turn it back into a copy of the original visual. |
| ToXml | Convert a visual to XML. Use Document.CreateVisual to turn it back into a copy of the original visual. |
| TransformFromWorld | Transform a world coordinate to a local coordinate |
| TransformFromWorldNormal | Transform a world normal to a local normal |
| TransformFromWorldRotationDegrees | Transform a world rotation (in degrees) to a local rotation (in degrees). |
| TransformFromWorldRotationRadians | Transform a world rotation (in radians) to a local rotation (in radians). |
| TransformToParent | Transform a local coordinate to coordinate local to parent. |
| TransformToParentNormal | Transform a local normal to normal local to parent |
| TransformToWorld | Transform a local coordinate to a world coordinate. |
| TransformToWorldNormal | Transform a local normal to a world normal. |
| TransformToWorldRotationDegrees | Transform a local rotation (in radians) to a world rotation (in radians). |
| TransformToWorldRotationRadians | Transform a local rotation (in radians) to a world rotation (in radians). |
| TranslateLocalX(Double) | Instantly move the visual along the local X axis of its initial matrix by xOffset units. |
| TranslateLocalX(Double, Double) | Move the visual along the local X axis of its initial matrix by xOffset units, at the given speed. |
| 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 |
| TranslateLocalY(Double) | Instantly move the visual along the local Y axis of its initial matrix by yOffset units. |
| TranslateLocalY(Double, Double) | Move the visual along the local Y axis of its initial matrix by yOffset units, at the given speed. |
| 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 |
| TranslateLocalZ(Double) | Instantly move the visual along the local Z axis of its initial matrix by zOffset units. |
| TranslateLocalZ(Double, Double) | Move the visual along the local Z axis of its initial matrix by zOffset units, at the given speed. |
| 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 |
| TranslateX(Double) | Instantly move the visual along the model's X axis by xOffset units |
| TranslateX(Double, Double) | Move the visual along the model's X axis by xOffset units, at the given speed. |
| TranslateX(Double, Double, Double, Double) | Move the visual along the model's X axis by xOffset units, at the given speed and acceleration |
| TranslateY(Double) | Instantly move the visual along the model's Y axis by yOffset units |
| TranslateY(Double, Double) | Move the visual along the model's Y axis by yOffset units, at the given speed. |
| TranslateY(Double, Double, Double, Double) | Move the visual along the model's Y axis by yOffset units, at the given speed and acceleration. |
| TranslateZ(Double) | Instantly move the visual along the model's Z axis by zOffset units |
| TranslateZ(Double, Double) | Move the visual along the model's Z axis by zOffset units, at the given speed. |
| TranslateZ(Double, Double, Double, Double) | Move the visual along the model's Z axis by zOffset units, at the given speed and acceleration. |
| TurnTo(Matrix) | Immediate Matrix TurnTo. |
| TurnTo(Vector3) | Turn to a new yaw pitch roll instantly. |
| 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. |
| TurnTo(Matrix, Double) | Matrix TurnTo method. |
| TurnTo(Vector3, Double) | Turn to a new yaw pitch roll in a fixed time. |
| 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. |
| TurnTo(Axis, Double, Double) | Turns to a target rotation. |
| 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. |
| TurnTo(Visual, Matrix, SpeedProfile) | Main Matrix TurnTo method. |
| TurnTo(Visual, Matrix, Double) | Matrix TurnTo method. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| Unfreeze | Release the load in one position by making it dynamic. |
| Unstick | Reparents this (stuck) visual to the scene and restores its physics state. |
| WaitForAnimator | |
| WakeUpSurroundingVisuals | Wake up any surrounding loads that might have been disabled so they don't remain in midair. |
Extension Methods| Name | Description | |
|---|---|---|
 | FullPropertyPath | (Defined by PathExtensions) |
See Also