Visual Methods |
The Visual type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | 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.
<p>
<strong>Note</strong>: For most uses, <code>AddCustomProperty(name,value,description)</code> or <code>AddSimpleProperty(name,value,description)</code> is more suitable, because there is no need to pass the type parameter; it is taken automatically from the value. |
| 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.
|
| 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.
|
| CustomPropertyDefined |
Determine whether a given custom property name is defined.
|
| 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.
|
| FadeToColorDeep |
Animate the primary color of a visual and all its descendants in a given time.
|
| 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.
|
| 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"
|
| FindCreateConnector |
Find or create a connector of the supplied name.
|
| 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(Type) |
Find all the objects in the Children of type Type (immediate children only)
|
| FindImmediateType(Type, IList) |
Find all the objects in the Children of type Type (immediate children only)
|
| FindParent(Type) |
Go back up through the parents of visuals to find a particular parent type.
|
| FindParent(PredicateVisual) |
Go back up through the parents of visuals to find a particular parent that matches the supplied predicate.
|
| FindType(Type) |
Find all the objects in the Descendants of type Type (all descendants)
|
| FindType(Type, IList) |
Find all the objects in the Descendants of type Type (all descendants)
|
| 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.
|
| HasCustomProperty |
Determines whether a custom property has been defined or not.
|
| IsAncestorOf |
Is this Visual a parent, grandparent, great grandparent etc. of the
potentialChild.
|
| IsDeleted |
Determine if the Visual been deleted.
|
| MoveToInitialPosition |
Move to the InitialPosition and InitialRotation.
|
| NotifyOnMouseUp | |
| 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.
|
| RemoveAspectT | |
| 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) | |
| Rotate(Axis, Double) | |
| Rotate(Axis, Double, Double) | |
| Rotate(Visual, Axis, SpeedProfile) | |
| Rotate(Visual, Axis, SpeedProfile, RotationDirection) | |
| RotateByImmediate | |
| RotateToImmediate | |
| RotateToLocalX | |
| RotateToLocalY | |
| RotateToLocalZ | |
| 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.
|
| 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.
|
| SimulateLoad |
Indicates that this Visual should now be in control of simulating the supplied load.
|
| SortChildrenAscendingT | |
| SortChildrenAscendingDeepT | |
| 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.
|
| 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 its local X axis by xOffset units
|
| TranslateLocalX(Double, Double) |
Move the visual along its local X axis by xOffset units, at the given speed.
|
| TranslateLocalX(Double, Double, Double, Double) |
Move the visual along its local X axis by xOffset units, at the given speed and acceleration
|
| TranslateLocalY(Double) |
Instantly move the visual along its local Y axis by yOffset units
|
| TranslateLocalY(Double, Double) |
Move the visual along its local Y axis by yOffset units, at the given speed.
|
| TranslateLocalY(Double, Double, Double, Double) |
Move the visual along its local Y axis by yOffset units, at the given speed and acceleration
|
| TranslateLocalZ(Double) |
Instantly move the visual along its local Z axis by zOffset units
|
| TranslateLocalZ(Double, Double) |
Move the visual along its local Z axis by zOffset units, at the given speed.
|
| TranslateLocalZ(Double, Double, Double, Double) |
Move the visual along its local Z axis 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) | |
| TurnTo(Matrix, Double) | |
| TurnTo(Vector3, Double) |
Turn to a new yaw pitch roll in a fixed time.
|
| TurnTo(Axis, Double, SpeedProfile) | |
| TurnTo(Axis, Double, Double) | |
| TurnTo(Matrix, Double, Double) | |
| TurnTo(Visual, Matrix, SpeedProfile) |
Main Matrix TurnTo method
|
| TurnTo(Visual, Matrix, Double) | |
| TurnTo(Axis, Double, SpeedProfile, RotationDirection) | |
| TurnTo(Axis, Double, Double, Double) | |
| TurnTo(Matrix, Double, Double, Double) | |
| TurnTo(Visual, Axis, Double, SpeedProfile) | |
| TurnTo(Visual, Axis, Double, Double) | |
| TurnTo(Visual, Matrix, Double, Double) | |
| TurnTo(Axis, Double, Double, Double, Double) | |
| TurnTo(Visual, Axis, Double, SpeedProfile, RotationDirection) | |
| TurnTo(Visual, Axis, Double, Double, Double) | |
| TurnTo(Visual, Matrix, Double, Double, Double) | |
| TurnTo(Visual, Axis, Double, Double, Double, Double) | |
| 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 | |
|---|---|---|
 | AddToComponent(String, IEnumerableVisual) | Overloaded.
Add a list of visuals to a component (or create a component).
(Defined by VisualComponent.) |
| AddToComponent(String, Visual) | Overloaded.
Add a list of visuals to a component (or create a component).
(Defined by VisualComponent.) |
| AddToComponent(Visual, String, Boolean) | Overloaded.
Mark this visual as a member of the component. Component must be the root of an existing component, or null.
If deep is set, then this visual and all its descendants will be added to the component. If deep is not set
but this visual is already a member of a component, then it and all its child visuals within the current component,
will be moved to the new component.
(Defined by VisualComponent.) |
| BelongsToComponent |
Returns true if this visual belongs to a specific component.
(Defined by VisualComponent.) |
| CommonComponentTypes |
Returns the component types common between this visual and a list of other visuals.
(Defined by VisualComponent.) |
| Component(String) | Overloaded.
Returns the component root for this visual.
(Defined by VisualComponent.) |
| Component(VisualComponentSearchCriteria) | Overloaded.
Returns the component root for this visual.
(Defined by VisualComponent.) |
| ComponentChildren(String) | Overloaded.
Returns all children of this component.
(Defined by VisualComponent.) |
| ComponentChildren(VisualComponentSearchCriteria) | Overloaded.
Returns all children of this component.
(Defined by VisualComponent.) |
| ComponentDescendants(String) | Overloaded.
Returns all descendants of this component.
(Defined by VisualComponent.) |
| ComponentDescendants(VisualComponentSearchCriteria) | Overloaded.
Returns all descendants of this component.
(Defined by VisualComponent.) |
| Components |
Returns all the components to which this visual belongs.
(Defined by VisualComponent.) |
| ComponentTypes |
Returns an ordered list of all the component types to which this visual belongs.
(Defined by VisualComponent.) |
| ComponentVisuals(String) | Overloaded.
Returns all the visuals belonging to this component.
(Defined by VisualComponent.) |
| ComponentVisuals(VisualComponentComponentType) | Overloaded.
Returns all the visuals belonging to this component.
(Defined by VisualComponent.) |
| ComponentVisuals(VisualComponentSearchCriteria) | Overloaded.
Returns all the visuals belonging to this component.
(Defined by VisualComponent.) |
| CreateComponent |
Mark this visual as a component.
(Defined by VisualComponent.) |
| FindComponentType(String) | Overloaded.
Returns a component type for this visual.
(Defined by VisualComponent.) |
| FindComponentType(VisualComponentSearchCriteria) | Overloaded.
Returns a component type for this visual.
(Defined by VisualComponent.) |
| IsComponentRoot(String) | Overloaded.
Returns true if this visual is the root of its component.
(Defined by VisualComponent.) |
| IsComponentRoot(VisualComponentSearchCriteria) | Overloaded.
Returns true if this visual is the root of its component.
(Defined by VisualComponent.) |
| IsComponentType |
Returns true if this visual is a component member of componentType.
(Defined by VisualComponent.) |
| RemoveFromComponent |
Remove this visual from component.
(Defined by VisualComponent.) |
See Also