All Frameworks  Object Hierarchy  This Framework  Indexes   

SWKDOF (Object)

This interface deals with a degree of freedom (DOF) of a manikin.

Property Index

DefaultValue
Returns the default value of a DOF.
FullName
Returns the full name of the degree of freedom (e.
LimitsLocked
Sets a lock on the limits.
MaxMean
Returns the mean value of the upper limit of the DOF (in radians).
MaxMeanInterSegment
MaxScore
Returns the highest score that this DOF can take.
MaxStdDev
Returns the standard deviation value of the upper limit of the DOF (in radians).
MaxValue
Returns or sets the highest value that a DOF can take.
MaxValueAsPercentile
Returns or sets the highest value that a DOF can take.
MinMean
Returns the mean value of the lower limit of the DOF (in radians).
MinMeanInterSegment
MinStdDev
Returns the standard deviation value of the lower limit of the DOF (in radians).
MinValue
Returns or sets the lowest value that a DOF can take.
MinValueAsPercentile
Returns or sets the lowest value that a DOF can take.
MinValueInterSegment
Number
Returns the number of the DOF.
Score
Returns the score corresponding to the DOF's current value.
Value
Returns or sets the value of a DOF.
ValueAsString
Returns or sets the value of a DOF, as a string.
ValueLocked
Sets a lock on the value.

Method Index

ResetValue
Sets the value of the DOF to its default value.
SetLimitsToMatchBestPrefAngle
Set the angular limitations to match with the best pref angle.

Properties


o Property DefaultValue() As (Read Only)
Returns the default value of a DOF. The value read is always in radians.
o Property FullName() As (Read Only)
Returns the full name of the degree of freedom (e.g. "flexion/extension").
This property is different from the property
Name of AnyObject,
which gives the short name or abbreviated name
of the DOF (e.g. "DOF1").

o Property LimitsLocked() As
Sets a lock on the limits.
When the value of this property is TRUE, the DOF travel limits are locked, therefore the min and max values cannot be changed.
When the value is FALSE, the DOF limits are unlocked and can be changed. By default, the DOF limits are locked and the application must unlock these limits before changing them.
o Property MaxMean() As (Read Only)
Returns the mean value of the upper limit of the DOF (in radians).
o Property MaxMeanInterSegment() As (Read Only)
o Property MaxScore() As (Read Only)
Returns the highest score that this DOF can take.
o Property MaxStdDev() As (Read Only)
Returns the standard deviation value of the upper limit of the DOF (in radians).
o Property MaxValue() As
Returns or sets the highest value that a DOF can take.
When setting the value, the new value given
cannot be higher than the statistical value found
in the limits database. This statistical maximum
value can be obtained by a call to property
StatisticalMaxValue.
o Property MaxValueAsPercentile() As
Returns or sets the highest value that a DOF can take.
When reading the value, the number returned
will take a percentile format, that is, will
be between 0.0 and 100.0 inclusive.

When setting the value, the new value given
must also lie in the range [ 0.0 ; 100.0 ].
o Property MinMean() As (Read Only)
Returns the mean value of the lower limit of the DOF (in radians).
o Property MinMeanInterSegment() As (Read Only)
o Property MinStdDev() As (Read Only)
Returns the standard deviation value of the lower limit of the DOF (in radians).
o Property MinValue() As
Returns or sets the lowest value that a DOF can take.
When setting the value, the new value given
cannot be lower than the statistical value found
in the limits database. This statistical minimum
value can be obtained by a call to property
StatisticalMinValue.
o Property MinValueAsPercentile() As
Returns or sets the lowest value that a DOF can take.
When reading the value, the number returned
will take a percentile format, that is, will
be between 0.0 and 100.0 exclusise.

When setting the value, the new value given
must also lie in the range [ 0.0 ; 100.0 ].
o Property MinValueInterSegment() As (Read Only)
o Property Number() As (Read Only)
Returns the number of the DOF. This number is an integer between 0 and 2.
See also:
SWKSegment
o Property Score() As (Read Only)
Returns the score corresponding to the DOF's current value.
o Property Value() As
Returns or sets the value of a DOF.
The value read or set is always in radians.
o Property ValueAsString() As
Returns or sets the value of a DOF, as a string.
Example:
myManikin.Body.GetSegment("LSLeTh"). ValueAsString = "10deg"
o Property ValueLocked() As
Sets a lock on the value.
When the value of this property is TRUE, the DOF's current value is locked and cannot be changed.
When this property is set to FALSE, the DOF value is unlocked and can be changed again. Locking a value on a DOF means that this DOF will ne take any other value than the current one, and will not be changed by an inverse kinematics resolution, for instance.

Methods


o Sub ResetValue()
Sets the value of the DOF to its default value.
o Sub SetLimitsToMatchBestPrefAngle()
Set the angular limitations to match with the best pref angle. The purpose of this method is to set the angular limitations of this DOF so that these limitations correspond to the best range of motion, that is, the range of motion where the postural score is the highest.

This method travels the different preferred angles on the DOF, then chooses the one with the highest score. If several preferred angles are found with the highest score, then the last one with the highest score is taken.

If no preferred angles have been defined on this DOF, then the angular limitations are not modified.

Copyright © 2003, Dassault Systèmes. All rights reserved.