Click or drag to resize

MechanismAspect Class

[Missing <summary> documentation for "T:Demo3D.Visuals.KJE.MechanismAspect"]

Inheritance Hierarchy

Namespace:  Demo3D.Visuals.KJE
Assembly:  Demo3D.Core (in Demo3D.Core.dll) Version: 15.0.2.11458
Syntax
C#
public class MechanismAspect : VisualAspect, 
	IDisposable

The MechanismAspect type exposes the following members.

Constructors
  NameDescription
Public methodMechanismAspect
Constructor.
Top
Properties
  NameDescription
Protected propertyapp (Inherited from VisualAspect.)
Public propertyAspectManagedBy
The Aspect that this is managed by.
(Inherited from AspectComponentBase.)
Public propertyCoordinateSystem
The coordinate system to use internally.
Protected propertydocument (Inherited from VisualAspect.)
Public propertyId (Inherited from SerializableObject.)
Public propertyIsCollapsed
Collapse or expand the aspect in the Aspect Viewer.
(Inherited from AspectComponentBase.)
Public propertyIsEnabled
The value for whether the aspect is enabled.
(Inherited from AspectComponentBase.)
Public propertyIsInitialized
Gets the value of whether or not this aspect has been initialized. An aspect is initialized during the scenes initialization when starting a model.
(Inherited from AspectComponentBase.)
Public propertyIsReadOnly
When true, disable editing in the Aspect Viewer
(Inherited from AspectComponentBase.)
Public propertyJoints
The list of joints that compose the mechanism.
Public propertyLinks
The list of links that compose the mechanism.
Public propertyName
A unique name for the aspect
(Inherited from AspectComponentBase.)
Public propertyRender
Whether the mechanism should be rendered.
Public propertySolverSettings
Solver settings.
Public propertySolverType
The solver type.
Public propertyVisual (Inherited from VisualAspect.)
Top
Methods
  NameDescription
Public methodAddGoal
Adds a goal to the mechanism to be solved.
Public methodAddJoint
Protected methodCanAdd
Determine whether the aspect can be added to the AspectContainer.
(Inherited from AspectComponentBase.)
Protected methodCleanupBindingAPI
Remove all bindable items that have been added to the binding api via UpdateBindingAPI.
(Inherited from AspectComponentBase.)
Public methodClear
Clears the mechanism, removing all joints and links.
Public methodClearGoals
Removes all goals from the mechanism.
Public methodContains(KinematicJoint)
Determines whether the mechanism contains the specified joint.
Public methodContains(KinematicLink)
Determines whether the mechanism contains the specified link.
Public methodDisableRebuild
Public methodDispose
Releases all resources used by the MechanismAspect
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the MechanismAspect and optionally releases the managed resources
Public methodEnableRebuild
Public methodFindAspectT
Find an aspect of the desired type in this aspect's container.
(Inherited from AspectComponentBase.)
Public methodFindCreateAspectT
Find or, if one isn't found, create an aspect of the desired type in this aspect's container.
(Inherited from AspectComponentBase.)
Public methodFindCreateGroundedLink
Finds or creates a grounded link.
Public methodFindCreateJointT
Attempts to find the joint that connects the specified base visual to the specified effector visual. If no existing joint exists then attempts to create a new joint of the specified type bound to links containing the specified visuals.
Public methodFindCreateLink
Attempts to find the link that contains the specified visual. If no existing link exists then attempts to create a new link containing the specified visual.
Public methodFindCreateManagedAspectT
Find or, if one isn't found, create a managed aspect of the desired type in this aspect's container. The managed aspect will be owned by the declared aspect.
(Inherited from AspectComponentBase.)
Public methodFindJoint
Attempts to find the joints that connects the specified base visual to the specified effector visual.
Public methodFindLink
Attempts to find the link that contains the specified visual.
Public methodInteractable
Whether the specified link can be interacted with through inverse kinematics.
Public methodMergeLinks
Protected methodOnAdded
Called after the mechanism aspect has been added to a visual.
(Overrides AspectComponentBaseOnAdded.)
Protected methodOnAssigned
Called after the mechanism aspect has been assigned to a visual.
(Overrides AspectComponentBaseOnAssigned.)
Protected methodOnDisabled
Called when the user requests to disable the aspect.
(Overrides AspectComponentBaseOnDisabled.)
Protected methodOnEnabled
Called when the user requests to enable the aspect.
(Overrides AspectComponentBaseOnEnabled.)
Protected methodOnInitialize
Called when the model is initialized.
(Overrides AspectComponentBaseOnInitialize.)
Protected methodOnRemoved
Called after the mechanism aspect has been removed from a visual.
(Overrides AspectComponentBaseOnRemoved.)
Protected methodOnReset
Resets the mechanism by resetting all links, joints and animators.
(Overrides AspectComponentBaseOnReset.)
Public methodPreStep
Prepares the mechanism for manual stepping.
Protected methodprint (Inherited from VisualAspect.)
Public methodPurgeLinks
Removes all unreferenced links.
Public methodRaisePropertiesChanged
Raise an PropertyChanged event for each value.
(Inherited from BindableBase.)
Public methodRaisePropertyChanged(PropertyChangedEventArgs)
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.)
Public methodRaisePropertyChanged(String)
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.)
Public methodRebuild
Tears down and rebuilds the internal KJE mechanism.
Public methodRemoveAspect(Object)
Remove the desired aspect from this aspect's container.
(Inherited from AspectComponentBase.)
Public methodRemoveAspectT
Remove the aspect of the desired type from this aspect's container.
(Inherited from AspectComponentBase.)
Public methodRemoveGoal
Removes a goal from the mechanism.
Public methodRemoveJoint
Public methodRemoveManagedAspects
Remove all aspects that are being managed by this aspect..
(Inherited from AspectComponentBase.)
Public methodSerializableDependency(SerializableObject)
Whether the specified object depends on the serializable object.
(Inherited from AspectComponentBase.)
Public methodSerializableDependency(Visual)
Whether the specified visual depends on the serializable object.
(Inherited from AspectComponentBase.)
Public methodSerialize
Public methodSerializeToFile
Protected methodSetINotifyPropertyChangedPropertyT
Checks to see if the property is the same as the specified value. It they're different then set the value and raise an PropertyChanged event. Property changes on the new value are also listened to and, if one occurs, the propertyChangedCallback handler will be invoked.
(Inherited from BindableBase.)
Protected methodSetPropertyT(T, T, PropertyChangedEventArgs)
Checks to see if the property is the same as the specified value. It they're different then set the value and raise an PropertyChanged event.
(Inherited from BindableBase.)
Protected methodSetPropertyT(T, T, String)
Checks to see if the property is the same as the specified value. It they're different then set the value and raise an PropertyChanged event.
(Inherited from BindableBase.)
Public methodSolution
Solves the mechanism without applying the solution.
Public methodSolve
Solves and applies the solution.
Public methodSolve(IGoal)
Solves with the additional specified goals and applies the solution.
Public methodSolve(IGoal, KinematicJoint)
Solves the specified subset of joints with the additional specified goals.
Public methodStep
Solves the mechanism and applies solutions, moving any visuals.
Public methodToString (Inherited from AspectComponentBase.)
Protected methodUpdateBindingAPI
If this aspect implements IBindableItemOwner, this method performs the following for each BindableItem:
If the aspect is disabled OR the item is not part of the binding interface (see IsBindingInterface), then remove it from the binding API.
Otherwise, if the item is part of the binding interface AND the item does not already have a declared binding (see HasBindingInterface), add the item to the binding API.
Any bindable items that are added to the binding API will appear in the IO browser grid and can be further utilized for controls testing.
(Inherited from AspectComponentBase.)
Public methodUpdateForwardKinematicParametersFromMotors
Updates all forward kinematic parameters with the values from their motors.
Protected methodvector (Inherited from VisualAspect.)
Top
Events
  NameDescription
Public eventIsEnabledChanged
Occurs when the value of IsEnabled changes.
(Inherited from AspectComponentBase.)
Public eventOnEndInteraction
Event triggered after ending attempting to interact with a link.
Public eventOnInteractableChanged
Event triggered after links may have changed their interactable status.
Public eventOnInteraction
Event triggered after attempting to interact with a link.
Public eventOnMechanismPreSolve
Event triggered just before the mechanism is solved during the usual time-stepping routine.
Public eventOnMechanismSolved
Event triggered after the mechanism has been solved during the usual time-stepping routine.
Public eventOnStartInteraction
Event triggered after attempting to start interacting with a link.
Top
Fields
  NameDescription
Protected fieldStatic memberBrowseValue
Top
See Also