KinematicHelicalJointDescription Class

A kinematic helical joint.

Inheritance Hierarchy

SystemObject
  System.DynamicDynamicObject
    NotifyPropertyChangedBase
      SimpleCustomTypeDescriptor
        GlobalizedProperties
          Demo3D.CommonBindableBase
            Demo3D.VisualsSerializableObject
              Demo3D.VisualsAspectComponentBase
                Demo3D.VisualsVisualAspect
                  Demo3D.VisualsBindableVisualAspect
                    Demo3D.VisualsExportableVisualAspect
                      Demo3D.ComponentsKinematicJointDescription
                        Demo3D.ComponentsKinematicHelicalJointDescription

Namespace: Demo3D.Components
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 14.0.0.10531

Syntax

Copy

public class KinematicHelicalJointDescription : KinematicJointDescription

The KinematicHelicalJointDescription type exposes the following members.

Constructors

	Name	Description
	KinematicHelicalJointDescription	Initializes a new instance of the KinematicHelicalJointDescription class

Top

Properties

	Name	Description
	Anchor	The (local) anchor for the helical joint.
	AngleOffset	The displacement value to angle value offset for the helical joint.
	AngleRatio	The angle:displacement ratio for the helical joint.
	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.)
	Axis	The (local) axis for the helical joint.
	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.)
	DisplacementBindableItem
	DistanceOffset	The displacement value to distance value offset for the helical joint.
	DistanceRatio	The distance:displacement ratio for the helical joint.
	document	(Inherited from VisualAspect.)
	Expression	The expression for the displacement value.
	Id	(Inherited from SerializableObject.)
	InitialValue	The initial displacement value.
	IO
	IsCollapsed	Collapse or expand the aspect in the Aspect Viewer. (Inherited from AspectComponentBase.)
	IsEnabled	(Inherited from AspectComponentBase.)
	IsInitialized	(Inherited from AspectComponentBase.)
	IsReadOnly	(Inherited from AspectComponentBase.)
	Joint	(Overrides KinematicJointDescriptionJoint.)
	LowerLimit	The lower limit for the displacement value.
	LowerLimitEnabled	Whether the displacement value has a lower limit.
	Mode	The mode for the displacement parameter.
	Motor	The motor that drives the displacement value.
	Name	A unique name for the aspect (Inherited from AspectComponentBase.)
	UpperLimit	The upper limit for the displacement value.
	UpperLimitEnabled	Whether the displacement value has an upper limit.
	Value	The current displacement value.
	Visual	(Inherited from VisualAspect.)

Top

Methods

	Name	Description
	CanAdd	Determine whether the aspect can be added to the AspectContainer. (Inherited from AspectComponentBase.)
	CleanupBindingAPI	(Inherited from AspectComponentBase.)
	FindAspectT	(Inherited from AspectComponentBase.)
	FindCreateAspectT	(Inherited from AspectComponentBase.)
	FindCreateManagedAspectT	(Inherited from AspectComponentBase.)
	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).)
	print	(Inherited from VisualAspect.)
	RaisePropertiesChanged	(Inherited from BindableBase.)
	RaisePropertyChanged(PropertyChangedEventArgs)	(Inherited from BindableBase.)
	RaisePropertyChanged(String)	(Inherited from BindableBase.)
	RemoveAspect(Object)	(Inherited from AspectComponentBase.)
	RemoveAspectT	(Inherited from AspectComponentBase.)
	RemoveManagedAspects	(Inherited from AspectComponentBase.)
	SerializableDependency(SerializableObject)	(Inherited from AspectComponentBase.)
	SerializableDependency(Visual)	(Inherited from AspectComponentBase.)
	SetT	(Inherited from KinematicJointDescription.)
	SetINotifyPropertyChangedPropertyT	(Inherited from BindableBase.)
	SetPropertyT(T, T, PropertyChangedEventArgs)	(Inherited from BindableBase.)
	SetPropertyT(T, T, String)	(Inherited from BindableBase.)
	SetVisualLocationT	(Inherited from KinematicJointDescription.)
	ToString	(Inherited from AspectComponentBase.)
	UpdateBindingAPI	(Inherited from AspectComponentBase.)
	UpdateBindingInterface	(Inherited from BindableVisualAspect.)
	UpdateJointInternal	(Overrides KinematicJointDescriptionUpdateJointInternal.)
	vector	(Inherited from VisualAspect.)

Top

Events

	Name	Description
	IsEnabledChanged	(Inherited from AspectComponentBase.)

Top

Fields

	Name	Description
	updatingFromMechanism	(Inherited from KinematicJointDescription.)

Top

Reference

Demo3D.Components Namespace