KinematicPlanarJointDescription Class |
A kinematic planar joint.
Inheritance HierarchySystemObject
System.DynamicDynamicObject
NotifyPropertyChangedBase
SimpleCustomTypeDescriptor
GlobalizedProperties
Demo3D.CommonBindableBase
Demo3D.VisualsSerializableObject
Demo3D.VisualsAspectComponentBase
Demo3D.VisualsVisualAspect
Demo3D.VisualsBindableVisualAspect
Demo3D.VisualsExportableVisualAspect
Demo3D.ComponentsKinematicJointDescription
Demo3D.ComponentsKinematicPlanarJointDescription
System.DynamicDynamicObject
NotifyPropertyChangedBase
SimpleCustomTypeDescriptor
GlobalizedProperties
Demo3D.CommonBindableBase
Demo3D.VisualsSerializableObject
Demo3D.VisualsAspectComponentBase
Demo3D.VisualsVisualAspect
Demo3D.VisualsBindableVisualAspect
Demo3D.VisualsExportableVisualAspect
Demo3D.ComponentsKinematicJointDescription
Demo3D.ComponentsKinematicPlanarJointDescription
Namespace: Demo3D.Components
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 15.0.2.11458
SyntaxC#
public class KinematicPlanarJointDescription : KinematicJointDescription
The KinematicPlanarJointDescription type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | KinematicPlanarJointDescription | Initializes a new instance of the KinematicPlanarJointDescription class |
Properties| Name | Description | |
|---|---|---|
 | Anchor | The (local) anchor for the rotation about the normal for the planar joint. |
| AngleBindableItem | |
| AngleExpression | The expression for the rotation angle. |
| AngleInitialValue | The initial rotation angle. |
| AngleLimitsEnabled | Whether the rotation angle is limited. |
| AngleLowerLimit | The lower limit for the rotation angle. |
| AngleMode | The mode for the rotation angle parameter. |
| AngleMotor | The motor that drives the rotation angle. |
| AngleType | Whether the rotation angle is continuous or discontinuous. |
| AngleUpperLimit | The upper limit for the rotation angle. |
| AngleValue | The current rotation angle. |
 | app | (Inherited from VisualAspect.) |
| AspectId | An internal CAD-package specific Id for the Aspect. (Inherited from ExportableVisualAspect.) |
| AspectManagedBy |
The Aspect that this is managed by.
(Inherited from AspectComponentBase.) |
| Axis1 | The first (local) axis of translation, which should be orthogonal to the normal of the plane. The second axis is taken to be the axis orthogonal to both the normal and the first axis according to the handedness of the coordinate system. |
| Base | The optional base visual that the primary visual is moved relative to (leave blank for the ground/world). (Inherited from KinematicJointDescription.) |
| BindableItems | |
| BindingInterface | (Inherited from BindableVisualAspect.) |
| ContextVisual | The Visual that represents the top level part or assembly from the CAD package. (Inherited from ExportableVisualAspect.) |
| Distance1BindableItem | |
| Distance1Expression | The expression for the first axis translation distance. |
| Distance1InitialValue | The initial first axis translation distance. |
| Distance1LowerLimit | The lower limit for the first axis translation distance. |
| Distance1LowerLimitEnabled | Whether the first axis translation distance has a lower limit. |
| Distance1Mode | The mode for the first axis translation distance parameter. |
| Distance1Motor | The motor that drives the first axis translation distance. |
| Distance1UpperLimit | The upper limit for the first axis translation distance. |
| Distance1UpperLimitEnabled | Whether the first axis translation distance has an upper limit. |
| Distance1Value | The current first axis translation distance. |
| Distance2BindableItem | |
| Distance2Expression | The expression for the second axis translation distance. |
| Distance2InitialValue | The initial second axis translation distance. |
| Distance2LowerLimit | The lower limit for the second axis translation distance. |
| Distance2LowerLimitEnabled | Whether the second axis translation distance has a lower limit. |
| Distance2Mode | The mode for the second axis translation distance parameter. |
| Distance2Motor | The motor that drives the second axis translation distance. |
| Distance2UpperLimit | The upper limit for the second axis translation distance. |
| Distance2UpperLimitEnabled | Whether the second axis translation distance has an upper limit. |
| Distance2Value | The current second axis translation distance. |
| document | (Inherited from VisualAspect.) |
| Id | (Inherited from SerializableObject.) |
| IO | |
| IsCollapsed |
Collapse or expand the aspect in the Aspect Viewer.
(Inherited from AspectComponentBase.) |
| IsEnabled |
The value for whether the aspect is enabled.
(Inherited from AspectComponentBase.) |
| IsInitialized |
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.) |
| IsReadOnly |
When true, disable editing in the Aspect Viewer
(Inherited from AspectComponentBase.) |
| Joint | (Inherited from KinematicJointDescription.) |
| Name | A unique name for the aspect (Inherited from AspectComponentBase.) |
| Normal | The (local) axis of rotation orthogonal to the plane of translation for the planar joint. |
| Visual | (Inherited from VisualAspect.) |
Methods| Name | Description | |
|---|---|---|
 | CanAdd |
Determine whether the aspect can be added to the AspectContainer.
(Inherited from AspectComponentBase.) |
| CleanupBindingAPI |
Remove all bindable items that have been added to the binding api via UpdateBindingAPI.
(Inherited from AspectComponentBase.) |
| FindAspectT |
Find an aspect of the desired type in this aspect's container.
(Inherited from AspectComponentBase.) |
| FindCreateAspectT |
Find or, if one isn't found, create an aspect of the desired type in this aspect's container.
(Inherited from AspectComponentBase.) |
| FindCreateManagedAspectT |
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.) |
| NotifyParameterValueChanged | (Inherited from KinematicJointDescription.) |
| OnAdded | (Overrides KinematicJointDescriptionOnAdded.) |
| OnAssigned | (Overrides BindableVisualAspectOnAssigned.) |
| OnBindableItemUpdated | (Overrides KinematicJointDescriptionOnBindableItemUpdated(BindableItem, ConnectionsUpdateType).) |
| OnDisabled | (Inherited from KinematicJointDescription.) |
| OnEnabled | (Inherited from KinematicJointDescription.) |
| OnInitialize |
Called when the aspect container is Initialized, this should never be invoked manually
(Inherited from AspectComponentBase.) |
| OnJointChanged | (Overrides KinematicJointDescriptionOnJointChanged(KinematicJoint, String).) |
| OnJointInitialize | (Overrides KinematicJointDescriptionOnJointInitialize.) |
| OnJointReset | (Overrides KinematicJointDescriptionOnJointReset.) |
| OnParameterChanged | (Overrides KinematicJointDescriptionOnParameterChanged(Parameter, String).) |
| OnRemoved | (Inherited from KinematicJointDescription.) |
| OnReset |
Called when the aspect container is Reset, this should never be invoked manually
(Inherited from AspectComponentBase.) |
| OnVisualLocationChanged | (Overrides KinematicJointDescriptionOnVisualLocationChanged(VisualLocation, String).) |
| (Inherited from VisualAspect.) | |
| RaisePropertiesChanged |
Raise an PropertyChanged event for each value.
(Inherited from BindableBase.) |
| RaisePropertyChanged(PropertyChangedEventArgs) |
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.) |
| RaisePropertyChanged(String) |
Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase.) |
| RemoveAspect(Object) |
Remove the desired aspect from this aspect's container.
(Inherited from AspectComponentBase.) |
| RemoveAspectT |
Remove the aspect of the desired type from this aspect's container.
(Inherited from AspectComponentBase.) |
| RemoveManagedAspects |
Remove all aspects that are being managed by this aspect..
(Inherited from AspectComponentBase.) |
| SerializableDependency(SerializableObject) |
Whether the specified object depends on the serializable object.
(Inherited from AspectComponentBase.) |
| SerializableDependency(Visual) |
Whether the specified visual depends on the serializable object.
(Inherited from AspectComponentBase.) |
| SetT | (Inherited from KinematicJointDescription.) |
| SetINotifyPropertyChangedPropertyT |
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.) |
| SetPropertyT(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.) |
| SetPropertyT(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.) |
| SetVisualLocationT | (Inherited from KinematicJointDescription.) |
| ToString | (Inherited from AspectComponentBase.) |
| UpdateBindingAPI |
If this aspect implements IBindableItemOwner, this method performs the following for each BindableItem: (Inherited from AspectComponentBase.)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. |
| UpdateBindingInterface | (Inherited from BindableVisualAspect.) |
| UpdateJointInternal | (Overrides KinematicJointDescriptionUpdateJointInternal.) |
| vector | (Inherited from VisualAspect.) |
Events| Name | Description | |
|---|---|---|
 | IsEnabledChanged |
Occurs when the value of IsEnabled changes.
(Inherited from AspectComponentBase.) |
| OnParameterValueChanged |
Event that is triggered when a parameter value changes.
(Inherited from KinematicJointDescription.) |
Fields| Name | Description | |
|---|---|---|
 | updatingFromMechanism | (Inherited from KinematicJointDescription.) |
See Also