Click or drag to resize

KinematicHelicalJointDescription Class

A kinematic helical joint.
Inheritance Hierarchy

Namespace:  Demo3D.Components
Assembly:  Demo3D.Core (in Demo3D.Core.dll) Version: 15.0.2.11458
Syntax
C#
public class KinematicHelicalJointDescription : KinematicJointDescription

The KinematicHelicalJointDescription type exposes the following members.

Constructors
  NameDescription
Public methodKinematicHelicalJointDescription
Initializes a new instance of the KinematicHelicalJointDescription class
Top
Properties
  NameDescription
Public propertyAnchor
The (local) anchor for the helical joint.
Public propertyAngleOffset
The displacement value to angle value offset for the helical joint.
Public propertyAngleRatio
The angle:displacement ratio for the helical joint.
Protected propertyapp (Inherited from VisualAspect.)
Public propertyAspectId
An internal CAD-package specific Id for the Aspect.
(Inherited from ExportableVisualAspect.)
Public propertyAspectManagedBy
The Aspect that this is managed by.
(Inherited from AspectComponentBase.)
Public propertyAxis
The (local) axis for the helical joint.
Public propertyBase
The optional base visual that the primary visual is moved relative to (leave blank for the ground/world).
(Inherited from KinematicJointDescription.)
Public propertyBindableItems
Protected propertyBindingInterface (Inherited from BindableVisualAspect.)
Public propertyContextVisual
The Visual that represents the top level part or assembly from the CAD package.
(Inherited from ExportableVisualAspect.)
Public propertyDisplacementBindableItem
Public propertyDistanceOffset
The displacement value to distance value offset for the helical joint.
Public propertyDistanceRatio
The distance:displacement ratio for the helical joint.
Protected propertydocument (Inherited from VisualAspect.)
Public propertyExpression
The expression for the displacement value.
Public propertyId (Inherited from SerializableObject.)
Public propertyInitialValue
The initial displacement value.
Public propertyIO
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 propertyJoint (Overrides KinematicJointDescriptionJoint.)
Public propertyLowerLimit
The lower limit for the displacement value.
Public propertyLowerLimitEnabled
Whether the displacement value has a lower limit.
Public propertyMode
The mode for the displacement parameter.
Public propertyMotor
The motor that drives the displacement value.
Public propertyName
A unique name for the aspect
(Inherited from AspectComponentBase.)
Public propertyUpperLimit
The upper limit for the displacement value.
Public propertyUpperLimitEnabled
Whether the displacement value has an upper limit.
Public propertyValue
The current displacement value.
Public propertyVisual (Inherited from VisualAspect.)
Top
Methods
  NameDescription
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 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 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.)
Protected methodNotifyParameterValueChanged (Inherited from KinematicJointDescription.)
Protected methodOnAdded (Overrides KinematicJointDescriptionOnAdded.)
Protected methodOnAssigned (Overrides BindableVisualAspectOnAssigned.)
Protected methodOnBindableItemUpdated (Overrides KinematicJointDescriptionOnBindableItemUpdated(BindableItem, ConnectionsUpdateType).)
Protected methodOnDisabled (Inherited from KinematicJointDescription.)
Protected methodOnEnabled (Inherited from KinematicJointDescription.)
Protected methodOnInitialize
Called when the aspect container is Initialized, this should never be invoked manually
(Inherited from AspectComponentBase.)
Protected methodOnJointChanged (Overrides KinematicJointDescriptionOnJointChanged(KinematicJoint, String).)
Protected methodOnJointInitialize (Overrides KinematicJointDescriptionOnJointInitialize.)
Protected methodOnJointReset (Overrides KinematicJointDescriptionOnJointReset.)
Protected methodOnParameterChanged (Overrides KinematicJointDescriptionOnParameterChanged(Parameter, String).)
Protected methodOnRemoved (Inherited from KinematicJointDescription.)
Protected methodOnReset
Called when the aspect container is Reset, this should never be invoked manually
(Inherited from AspectComponentBase.)
Protected methodOnVisualLocationChanged (Overrides KinematicJointDescriptionOnVisualLocationChanged(VisualLocation, String).)
Protected methodprint (Inherited from VisualAspect.)
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 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 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.)
Protected methodSetT (Inherited from KinematicJointDescription.)
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.)
Protected methodSetVisualLocationT (Inherited from KinematicJointDescription.)
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.)
Protected methodUpdateBindingInterface (Inherited from BindableVisualAspect.)
Protected methodUpdateJointInternal (Overrides KinematicJointDescriptionUpdateJointInternal.)
Protected methodvector (Inherited from VisualAspect.)
Top
Events
  NameDescription
Public eventIsEnabledChanged
Occurs when the value of IsEnabled changes.
(Inherited from AspectComponentBase.)
Public eventOnParameterValueChanged
Event that is triggered when a parameter value changes.
(Inherited from KinematicJointDescription.)
Top
Fields
  NameDescription
Protected fieldupdatingFromMechanism (Inherited from KinematicJointDescription.)
Top
See Also