HumanBuilder Class¶
-
class
NXOpen.Features.
HumanBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a human feature.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateHumanBuilder()
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
BalanceType | Returns or sets the balance type of active reach |
BodyParts | Returns or sets the manipulated body parts for dynamic drag |
CurrentComfortStudyName | Returns or sets the current study name of comfort analysis |
CustomHumanFileName | Returns the custom human figure file name |
Database | Returns the database for human |
ExpressionStatureData | Returns the human stature data using expression |
ExpressionWeightData | Returns the human weight data using expression |
FollowFoot | Returns or sets the status of follow foot move for dynamic drag of left foot or right foot. |
Gender | Returns the human gender data |
HeadEyeType | Returns or sets the head eye type of active reach |
InitJoint | Returns or sets the motion initiation joint for dynamic drag of left hand or right hand |
InverseKinematicsOrientation | Returns or sets the orientaion of dynamic drag |
InverseKinematicsPosition | Returns or sets the position of dynamic drag. |
InverseKinematicsType | Returns or sets the type of inverse kinematics: dynamic drag or active reach |
LockWrist | Returns or sets the status of lock wrist for dynamic drag of left hand or right hand. |
Name | Returns the human name |
Orientation | Returns the human orientaion |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
Position | Returns the human position |
ReferencePointCoordinates | Returns the reference point coordinates |
ReferencePointType | Returns the reference point type |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddHandShapeLib | Add hand shape library |
AddPostureLib | Add posture library |
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
DoUpdate | Update human |
ExportCustomHumanFile | Export custom human file |
ExportCustomPostureFile | Export custom posture file |
GetBarrierCsys | Gets barrier csys for active reach, returns None if there is no barrier @return the barrier csys |
GetBarrierNormal | Gets barrier normal dirrection for active reach, returns None if the there is no barrier @return the normal of barrier plane |
GetBarrierPoint | Gets barrier point for active reach, returns None if there is no barrier @return the barrier point |
GetBodySiteDisplayFlag | Get the default body parts site CSYS display flag. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFeature | Returns the feature currently being edited by this builder. |
GetHandGoalAllowNormal | Gets the allow normal status of hand goal for active reach @return the allow normal flag of hand goal |
GetHandGoalAllowRotate | Gets the allow rotate status of hand goal for active reach @return the allow rotate flag of hand goal |
GetHandGoalCsys | Gets hand goal csys for active reach, returns None if the hand goal type is not csys @return the goal csys |
GetHandGoalOrientation | Gets hand goal orientaion for active reach, returns None if the hand goal type is not hand figure or point @return hand goal orientation matrix relative to the absolute coordinate system. |
GetHandGoalPoint | Gets hand goal point for active reach, returns None if the hand goal type is not point @return the goal point |
GetHandGoalPosition | Gets hand goal position for active reach, returns None if the hand goal type is not hand figure @return hand goal global location for active reach |
GetHandGoalType | Gets hand goal type for active reach @return hand goal type for active reach: point, csys or hand figure |
GetObject | Returns the object currently being edited by this builder. |
GetPosturePrediction | Get the posture prediction object from human builder. |
GetSegmentSitesName | Get the segment site name of edit human display. |
GetStatureData | Gets human stature data |
GetWeightData | Gets human weight data |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
LoadCustomPostureFile | Load custom posture file |
RemoveHandShapeLib | Remove hand shape library |
RemovePostureLib | Remove posture library |
SetAdvancedScalingData | Set data for advanced scaling |
SetBarrierCsys | Sets barrier csys for active reach, the human will be hold by the position and orientaion of the csys in active reach |
SetBarrierNormal | Sets barrier normal direction for active reach, the human will be hold by the position of point and orientaion of the barrier normal in active reach |
SetBarrierPoint | Sets barrier point active reach, the human will be hold by the position of point in active reach |
SetBodySiteDisplayFlag | Set the default body parts site CSYS display flag. |
SetCustomHumanFileName | Sets custom human figure file name |
SetDatabase | Sets database for human |
SetExpressionStatureData | Sets human stature data using expression |
SetExpressionWeightData | Sets human weight data using expression |
SetGender | Sets human gender data |
SetHandGoalAllowNormal | Sets the allow normal status of hand goal for active reach, if it is TRUE, use the palmcenter site with the target z axis normal to define the hand orientation |
SetHandGoalAllowRotate | Sets the allow rotate status of hand for active reach, if it is TRUE, rotate the target z axis normal to the best guess directions to define the hand orientation |
SetHandGoalCsys | Sets hand goal csys for active reach, the hand goal type should be set as csys |
SetHandGoalOrientation | Sets hand goal orientaion for active reach, the hand goal type should be hand figure or point |
SetHandGoalPoint | Sets hand goal point for active reach, the hand goal type should be point |
SetHandGoalPosition | Sets hand goal position for active reach, the hand goal type should be hand figure |
SetHandGoalType | Sets hand goal type for active reach |
SetHandShapeData | Sets the hand shape data |
SetJointData | Set joint data |
SetJointLimits | Set joint limits |
SetName | Sets human name |
SetOrientation | Sets human orientaion |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
SetPosition | Sets human position |
SetPostureData | Set posture data |
SetReferencePoint | Sets the reference point |
SetReferencePointCoordinates | Sets the reference point coordinates. |
SetReferencePointType | Sets the reference point type |
SetResetPosture | Set flag for reset posture |
SetResetSegment | Set flag for reset segment |
SetSegmentScalingData | Set segment data for segment scaling |
SetSegmentSitesName | Set the segment site name of edit human display. |
SetShowSkeleton | Set flag for show human skeleton |
SetStatureData | Sets human stature data |
SetWeightData | Sets human weight data |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
BalanceType¶
-
HumanBuilder.
BalanceType
¶ Returns or sets the balance type of active reach
-------------------------------------
Getter Method
Signature
BalanceType()
Returns: the balance type for active reach: allow step, no step or seated Return type: NXOpen.HumanDataInverseKinematicsBalanceType
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
BalanceType(balanceType)
Parameters: balanceType ( NXOpen.HumanDataInverseKinematicsBalanceType
) – the balance type for active reach: allow step, no step or seatedNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
BodyParts¶
-
HumanBuilder.
BodyParts
¶ Returns or sets the manipulated body parts for dynamic drag
-------------------------------------
Getter Method
Signature
BodyParts()
Returns: the body parts of dynamic drag Return type: NXOpen.HumanDataInverseKinematicsBodyParts
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
BodyParts(bodyParts)
Parameters: bodyParts ( NXOpen.HumanDataInverseKinematicsBodyParts
) – the body parts of dynamic dragNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
CurrentComfortStudyName¶
-
HumanBuilder.
CurrentComfortStudyName
¶ Returns or sets the current study name of comfort analysis
-------------------------------------
Getter Method
Signature
CurrentComfortStudyName()
Returns: the current comfort study name Return type: str New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
CurrentComfortStudyName(studyName)
Parameters: studyName (str) – the current comfort study name New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
CustomHumanFileName¶
-
HumanBuilder.
CustomHumanFileName
¶ Returns the custom human figure file name
-------------------------------------
Getter Method
Signature
CustomHumanFileName()
Returns: Figure file name if created from cloning Return type: str New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
Database¶
-
HumanBuilder.
Database
¶ Returns the database for human
-------------------------------------
Getter Method
Signature
Database()
Returns: Indicates database used for creating the human Return type: NXOpen.HumanDataDatabaseType
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
ExpressionStatureData¶
-
HumanBuilder.
ExpressionStatureData
¶ Returns the human stature data using expression
-------------------------------------
Getter Method
Signature
ExpressionStatureData()
Returns: Stature expression for custom stature input Return type: str New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
ExpressionWeightData¶
-
HumanBuilder.
ExpressionWeightData
¶ Returns the human weight data using expression
-------------------------------------
Getter Method
Signature
ExpressionWeightData()
Returns: Weight expression for custom weight input Return type: str New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
FollowFoot¶
-
HumanBuilder.
FollowFoot
¶ Returns or sets the status of follow foot move for dynamic drag of left foot or right foot.
If true, human follows foot move to keep balance
-------------------------------------
Getter Method
Signature
FollowFoot()
Returns: the status of follow foot move Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
FollowFoot(followFoot)
Parameters: followFoot (bool) – the status of follow foot move New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
Gender¶
-
HumanBuilder.
Gender
¶ Returns the human gender data
-------------------------------------
Getter Method
Signature
Gender()
Returns: Gender of the human Return type: NXOpen.HumanDataGenderType
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
HeadEyeType¶
-
HumanBuilder.
HeadEyeType
¶ Returns or sets the head eye type of active reach
-------------------------------------
Getter Method
Signature
HeadEyeType()
Returns: the head eye type for active reach: follow last defined or fixate Return type: NXOpen.HumanDataInverseKinematicsHeadEyeType
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
HeadEyeType(headEyeType)
Parameters: headEyeType ( NXOpen.HumanDataInverseKinematicsHeadEyeType
) – the head eye type for active reach: follow last defined or fixateNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
InitJoint¶
-
HumanBuilder.
InitJoint
¶ Returns or sets the motion initiation joint for dynamic drag of left hand or right hand
-------------------------------------
Getter Method
Signature
InitJoint()
Returns: the motion initiation joint: waist or shoulder Return type: NXOpen.HumanDataInverseKinematicsInitJoint
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
InitJoint(initJoint)
Parameters: initJoint ( NXOpen.HumanDataInverseKinematicsInitJoint
) – the motion initiation joint: waist or shoulderNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
InverseKinematicsOrientation¶
-
HumanBuilder.
InverseKinematicsOrientation
¶ Returns or sets the orientaion of dynamic drag
-------------------------------------
Getter Method
Signature
InverseKinematicsOrientation()
Returns: Inverse kinematics orientation matrix relative to the absolute coordinate system. Must be orthonormal :rtype:
NXOpen.Matrix3x3
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
InverseKinematicsOrientation(orientation)
Parameters: orientation ( NXOpen.Matrix3x3
) – Inverse kinematics orientation matrix relative to the absolute coordinate system. Must be orthonormalNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
InverseKinematicsPosition¶
-
HumanBuilder.
InverseKinematicsPosition
¶ Returns or sets the position of dynamic drag.
-------------------------------------
Getter Method
Signature
InverseKinematicsPosition()
Returns: dynamic drag global location Return type: NXOpen.Point3d
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
InverseKinematicsPosition(position)
Parameters: position ( NXOpen.Point3d
) – dynamic drag global locationNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
InverseKinematicsType¶
-
HumanBuilder.
InverseKinematicsType
¶ Returns or sets the type of inverse kinematics: dynamic drag or active reach
-------------------------------------
Getter Method
Signature
InverseKinematicsType()
Returns: the type of inverse kinematics Return type: NXOpen.HumanDataInverseKinematicsType
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
InverseKinematicsType(type)
Parameters: type ( NXOpen.HumanDataInverseKinematicsType
) – the type of inverse kinematicsNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
LockWrist¶
-
HumanBuilder.
LockWrist
¶ Returns or sets the status of lock wrist for dynamic drag of left hand or right hand.
If true, the wrist will be locked when dragging hands
-------------------------------------
Getter Method
Signature
LockWrist()
Returns: the flag of lock wrist for dynamic drag of left hand or right hand Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
LockWrist(lockWrist)
Parameters: lockWrist (bool) – the flag of lock wrist of inverse kinematics New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
Name¶
-
HumanBuilder.
Name
¶ Returns the human name
-------------------------------------
Getter Method
Signature
Name()
Returns: Name of the human Return type: str New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
Orientation¶
-
HumanBuilder.
Orientation
¶ Returns the human orientaion
-------------------------------------
Getter Method
Signature
Orientation()
Returns: Human orientation matrix relative to the absolute coordinate system. Must be orthonormal :rtype:
NXOpen.Matrix3x3
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
Position¶
-
HumanBuilder.
Position
¶ Returns the human position
-------------------------------------
Getter Method
Signature
Position()
Returns: Human global location Return type: NXOpen.Point3d
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
ReferencePointCoordinates¶
-
HumanBuilder.
ReferencePointCoordinates
¶ Returns the reference point coordinates
-------------------------------------
Getter Method
Signature
ReferencePointCoordinates()
Returns: Reference point coordinates Return type: NXOpen.Point3d
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
ReferencePointType¶
-
HumanBuilder.
ReferencePointType
¶ Returns the reference point type
-------------------------------------
Getter Method
Signature
ReferencePointType()
Returns: Type of reference point type Return type: NXOpen.HumanDataReferencePointType
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
Method Detail¶
AddHandShapeLib¶
-
HumanBuilder.
AddHandShapeLib
¶ Add hand shape library
Signature
AddHandShapeLib(handshapeLib)
Parameters: handshapeLib (str) – Hand shape library name New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
AddPostureLib¶
-
HumanBuilder.
AddPostureLib
¶ Add posture library
Signature
AddPostureLib(postureLib)
Parameters: postureLib (str) – Posture library name New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
DoUpdate¶
-
HumanBuilder.
DoUpdate
¶ Update human
Signature
DoUpdate(updatePosturePrediction, updateReferencePoint, updateReachZone)
Parameters: - updatePosturePrediction (bool) – Flag of update posture prediction
- updateReferencePoint (bool) – Flag of update reference point
- updateReachZone (bool) – Flag of update reach zone
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
ExportCustomHumanFile¶
-
HumanBuilder.
ExportCustomHumanFile
¶ Export custom human file
Signature
ExportCustomHumanFile(humanFileName)
Parameters: humanFileName (str) – Custom human file name New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
ExportCustomPostureFile¶
-
HumanBuilder.
ExportCustomPostureFile
¶ Export custom posture file
Signature
ExportCustomPostureFile(postureFileName)
Parameters: postureFileName (str) – Custom posture file name New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetBarrierCsys¶
-
HumanBuilder.
GetBarrierCsys
¶ Gets barrier csys for active reach, returns None if there is no barrier
Signature
GetBarrierCsys()
Returns: the barrier csys Return type: NXOpen.CoordinateSystem
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetBarrierNormal¶
-
HumanBuilder.
GetBarrierNormal
¶ Gets barrier normal dirrection for active reach, returns None if the there is no barrier
Signature
GetBarrierNormal()
Returns: the normal of barrier plane Return type: NXOpen.Vector3d
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetBarrierPoint¶
-
HumanBuilder.
GetBarrierPoint
¶ Gets barrier point for active reach, returns None if there is no barrier
Signature
GetBarrierPoint()
Returns: the barrier point Return type: NXOpen.Point
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetBodySiteDisplayFlag¶
-
HumanBuilder.
GetBodySiteDisplayFlag
¶ Get the default body parts site CSYS display flag.
Signature
GetBodySiteDisplayFlag(bodyPart)
Parameters: bodyPart ( NXOpen.HumanDataEditDisplayBodyParts
) – the body part of humanReturns: the body site display flag Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetHandGoalAllowNormal¶
-
HumanBuilder.
GetHandGoalAllowNormal
¶ Gets the allow normal status of hand goal for active reach
Signature
GetHandGoalAllowNormal(side)
Parameters: side ( NXOpen.HumanDataSideType
) – left side or right sideReturns: the allow normal flag of hand goal Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetHandGoalAllowRotate¶
-
HumanBuilder.
GetHandGoalAllowRotate
¶ Gets the allow rotate status of hand goal for active reach
Signature
GetHandGoalAllowRotate(side)
Parameters: side ( NXOpen.HumanDataSideType
) – left side or right sideReturns: the allow rotate flag of hand goal Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetHandGoalCsys¶
-
HumanBuilder.
GetHandGoalCsys
¶ Gets hand goal csys for active reach, returns None if the hand goal type is not csys
Signature
GetHandGoalCsys(side)
Parameters: side ( NXOpen.HumanDataSideType
) – left side or right sideReturns: the goal csys Return type: NXOpen.CoordinateSystem
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetHandGoalOrientation¶
-
HumanBuilder.
GetHandGoalOrientation
¶ Gets hand goal orientaion for active reach, returns None if the hand goal type is not hand figure or point
Signature
GetHandGoalOrientation(side)
Parameters: side ( NXOpen.HumanDataSideType
) – left side or right sideReturns: hand goal orientation matrix relative to the absolute coordinate system. Must be orthonormal :rtype:
NXOpen.Matrix3x3
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetHandGoalPoint¶
-
HumanBuilder.
GetHandGoalPoint
¶ Gets hand goal point for active reach, returns None if the hand goal type is not point
Signature
GetHandGoalPoint(side)
Parameters: side ( NXOpen.HumanDataSideType
) – left side or right sideReturns: the goal point Return type: NXOpen.Point
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetHandGoalPosition¶
-
HumanBuilder.
GetHandGoalPosition
¶ Gets hand goal position for active reach, returns None if the hand goal type is not hand figure
Signature
GetHandGoalPosition(side)
Parameters: side ( NXOpen.HumanDataSideType
) – left side or right sideReturns: hand goal global location for active reach Return type: NXOpen.Point3d
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetHandGoalType¶
-
HumanBuilder.
GetHandGoalType
¶ Gets hand goal type for active reach
Signature
GetHandGoalType(side)
Parameters: side ( NXOpen.HumanDataSideType
) – left side or right sideReturns: hand goal type for active reach: point, csys or hand figure Return type: NXOpen.HumanDataHandGoalType
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetPosturePrediction¶
-
HumanBuilder.
GetPosturePrediction
¶ Get the posture prediction object from human builder.
Posture prediction should be done first before get it from human builder
Signature
GetPosturePrediction()
Returns: HumanPosturePrediction
to be edited, None then no posture prediction has been doneReturn type: NXOpen.HumanPosturePrediction
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetSegmentSitesName¶
-
HumanBuilder.
GetSegmentSitesName
¶ Get the segment site name of edit human display.
Signature
GetSegmentSitesName()
Returns: the segment sites name Return type: list of str New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetStatureData¶
-
HumanBuilder.
GetStatureData
¶ Gets human stature data
Signature
GetStatureData()
Returns: a tuple Return type: A tuple consisting of (statureType, stature, statureUnit). statureType is a NXOpen.HumanDataStatureType
. Flag for percentile stature in database or actual stature measure stature is a float. Stature value statureUnit is aNXOpen.HumanDataStatureUnitType
. Unit for statureNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
GetWeightData¶
-
HumanBuilder.
GetWeightData
¶ Gets human weight data
Signature
GetWeightData()
Returns: a tuple Return type: A tuple consisting of (weightType, weight, weightUnit). weightType is a NXOpen.HumanDataWeightType
. Flag for percentile weight in database or actual weight value weight is a float. Weight value weightUnit is aNXOpen.HumanDataWeightUnitType
. Unit for weightNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
LoadCustomPostureFile¶
-
HumanBuilder.
LoadCustomPostureFile
¶ Load custom posture file
Signature
LoadCustomPostureFile(postureFileName)
Parameters: postureFileName (str) – Custom posture file name New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
RemoveHandShapeLib¶
-
HumanBuilder.
RemoveHandShapeLib
¶ Remove hand shape library
Signature
RemoveHandShapeLib(handshapeLib)
Parameters: handshapeLib (str) – Hand shape library name New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
RemovePostureLib¶
-
HumanBuilder.
RemovePostureLib
¶ Remove posture library
Signature
RemovePostureLib(postureLib)
Parameters: postureLib (str) – Posture library name New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetAdvancedScalingData¶
-
HumanBuilder.
SetAdvancedScalingData
¶ Set data for advanced scaling
Signature
SetAdvancedScalingData(dataName, dataValue)
Parameters: - dataName (
NXOpen.HumanDataAdvancedScalingType
) – Advanced scaling data name - dataValue (float) – Advanced scaling data value
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- dataName (
SetBarrierCsys¶
-
HumanBuilder.
SetBarrierCsys
¶ Sets barrier csys for active reach, the human will be hold by the position and orientaion of the csys in active reach
Signature
SetBarrierCsys(barrierCsys)
Parameters: barrierCsys ( NXOpen.CoordinateSystem
) – the goal csysNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetBarrierNormal¶
-
HumanBuilder.
SetBarrierNormal
¶ Sets barrier normal direction for active reach, the human will be hold by the position of point and orientaion of the barrier normal in active reach
Signature
SetBarrierNormal(barrierNormal)
Parameters: barrierNormal ( NXOpen.Vector3d
) – the normal of barrier plane, use the arbitrary normal direction if normal is not setNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetBarrierPoint¶
-
HumanBuilder.
SetBarrierPoint
¶ Sets barrier point active reach, the human will be hold by the position of point in active reach
Signature
SetBarrierPoint(barrierPoint)
Parameters: barrierPoint ( NXOpen.Point
) – the barrier pointNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetBodySiteDisplayFlag¶
-
HumanBuilder.
SetBodySiteDisplayFlag
¶ Set the default body parts site CSYS display flag.
If true, then display the site CSYS of human default body parts.
Signature
SetBodySiteDisplayFlag(bodyPart, displayFlag)
Parameters: - bodyPart (
NXOpen.HumanDataEditDisplayBodyParts
) – the body part of human - displayFlag (bool) – the body site display flag
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- bodyPart (
SetCustomHumanFileName¶
-
HumanBuilder.
SetCustomHumanFileName
¶ Sets custom human figure file name
Signature
SetCustomHumanFileName(customFileName)
Parameters: customFileName (str) – Figure file name if created from cloning New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetDatabase¶
-
HumanBuilder.
SetDatabase
¶ Sets database for human
Signature
SetDatabase(database)
Parameters: database ( NXOpen.HumanDataDatabaseType
) – Indicates database used for creating the humanNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetExpressionStatureData¶
-
HumanBuilder.
SetExpressionStatureData
¶ Sets human stature data using expression
Signature
SetExpressionStatureData(statureExpression)
Parameters: statureExpression (str) – Stature expression for custom stature input New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetExpressionWeightData¶
-
HumanBuilder.
SetExpressionWeightData
¶ Sets human weight data using expression
Signature
SetExpressionWeightData(weightExpression)
Parameters: weightExpression (str) – Weight expression for custom weight input New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetGender¶
-
HumanBuilder.
SetGender
¶ Sets human gender data
Signature
SetGender(gender)
Parameters: gender ( NXOpen.HumanDataGenderType
) – Gender of the humanNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetHandGoalAllowNormal¶
-
HumanBuilder.
SetHandGoalAllowNormal
¶ Sets the allow normal status of hand goal for active reach, if it is TRUE, use the palmcenter site with the target z axis normal to define the hand orientation
Signature
SetHandGoalAllowNormal(side, allowNormal)
Parameters: - side (
NXOpen.HumanDataSideType
) – left side or right side - allowNormal (bool) – the allow normal flag of hand goal
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- side (
SetHandGoalAllowRotate¶
-
HumanBuilder.
SetHandGoalAllowRotate
¶ Sets the allow rotate status of hand for active reach, if it is TRUE, rotate the target z axis normal to the best guess directions to define the hand orientation
Signature
SetHandGoalAllowRotate(side, allowRotate)
Parameters: - side (
NXOpen.HumanDataSideType
) – left side or right side - allowRotate (bool) – the allow rotate flag of hand goal
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- side (
SetHandGoalCsys¶
-
HumanBuilder.
SetHandGoalCsys
¶ Sets hand goal csys for active reach, the hand goal type should be set as csys
Signature
SetHandGoalCsys(side, goalCsys)
Parameters: - side (
NXOpen.HumanDataSideType
) – left side or right side - goalCsys (
NXOpen.CoordinateSystem
) – the goal csys
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- side (
SetHandGoalOrientation¶
-
HumanBuilder.
SetHandGoalOrientation
¶ Sets hand goal orientaion for active reach, the hand goal type should be hand figure or point
Signature
SetHandGoalOrientation(side, goalOrientation)
Parameters: - side (
NXOpen.HumanDataSideType
) – left side or right side - goalOrientation (
NXOpen.Matrix3x3
) – hand goal orientation matrix relative to the absolute coordinate system. Must be orthonormal
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- side (
SetHandGoalPoint¶
-
HumanBuilder.
SetHandGoalPoint
¶ Sets hand goal point for active reach, the hand goal type should be point
Signature
SetHandGoalPoint(side, goalPoint)
Parameters: - side (
NXOpen.HumanDataSideType
) – left side or right side - goalPoint (
NXOpen.Point
) – the goal point
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- side (
SetHandGoalPosition¶
-
HumanBuilder.
SetHandGoalPosition
¶ Sets hand goal position for active reach, the hand goal type should be hand figure
Signature
SetHandGoalPosition(side, goalPosition)
Parameters: - side (
NXOpen.HumanDataSideType
) – left side or right side - goalPosition (
NXOpen.Point3d
) – hand goal global location
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- side (
SetHandGoalType¶
-
HumanBuilder.
SetHandGoalType
¶ Sets hand goal type for active reach
Signature
SetHandGoalType(side, goalType)
Parameters: - side (
NXOpen.HumanDataSideType
) – left side or right side - goalType (
NXOpen.HumanDataHandGoalType
) – hand goal type for active reach: point, csys or hand figure
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- side (
SetHandShapeData¶
-
HumanBuilder.
SetHandShapeData
¶ Sets the hand shape data
Signature
SetHandShapeData(handType, handshapeName, neutralHandshapeName, handshapeLib, handshapeValue)
Parameters: - handType (int) – Left hand,right hand or both hands
- handshapeName (str) – Name of hand shape in the list
- neutralHandshapeName (str) – Name of neutral hand shape
- handshapeLib (str) – Library of hand shape
- handshapeValue (float) – Value for applying hand shape
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetJointData¶
-
HumanBuilder.
SetJointData
¶ Set joint data
Signature
SetJointData(jointName, jointXValue, jointYValue, jointZValue, isSymmetric)
Parameters: - jointName (
NXOpen.HumanDataJointType
) – Joint name - jointXValue (float) – X value for applying adjust joint
- jointYValue (float) – Y value for applying adjust joint
- jointZValue (float) – Z value for applying adjust joint
- isSymmetric (bool) – Flag of adjust symmetrical joint
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- jointName (
SetJointLimits¶
-
HumanBuilder.
SetJointLimits
¶ Set joint limits
Signature
SetJointLimits(jointName, jointXLowerLimit, jointXUpperLimit, jointYLowerLimit, jointYUpperLimit, jointZLowerLimit, jointZUpperLimit, isSymmetric)
Parameters: - jointName (
NXOpen.HumanDataJointType
) – Joint name - jointXLowerLimit (float) – X value of lower joint limit
- jointXUpperLimit (float) – X value of upper joint limit
- jointYLowerLimit (float) – Y value of lower joint limit
- jointYUpperLimit (float) – Y value of upper joint limit
- jointZLowerLimit (float) – Z value of lower joint limit
- jointZUpperLimit (float) – Z value of upper joint limit
- isSymmetric (bool) – Flag of adjust symmetrical joint
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- jointName (
SetName¶
-
HumanBuilder.
SetName
¶ Sets human name
Signature
SetName(name)
Parameters: name (str) – Name of the human New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetOrientation¶
-
HumanBuilder.
SetOrientation
¶ Sets human orientaion
Signature
SetOrientation(orientation)
Parameters: orientation ( NXOpen.Matrix3x3
) – Human orientation matrix relative to the absolute coordinate system. Must be orthonormalNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetPosition¶
-
HumanBuilder.
SetPosition
¶ Sets human position
Signature
SetPosition(location)
Parameters: location ( NXOpen.Point3d
) – Human global locationNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetPostureData¶
-
HumanBuilder.
SetPostureData
¶ Set posture data
Signature
SetPostureData(postureName, postureLib)
Parameters: - postureName (str) – Posture name
- postureLib (str) – Posture library
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetReferencePoint¶
-
HumanBuilder.
SetReferencePoint
¶ Sets the reference point
Signature
SetReferencePoint(associative, referencePointType, referencePoint)
Parameters: - associative (bool) – Flag for associative reference point
- referencePointType (
NXOpen.HumanDataReferencePointType
) – Type of reference point type - referencePoint (
NXOpen.Point
) – Reference point
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetReferencePointCoordinates¶
-
HumanBuilder.
SetReferencePointCoordinates
¶ Sets the reference point coordinates.
A dumb point will be created according to input point coordinates and set as reference point of human. The associative status of the reference will be set as FALSE.
Signature
SetReferencePointCoordinates(referencePointCoordinates)
Parameters: referencePointCoordinates ( NXOpen.Point3d
) – Reference point coordinatesNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetReferencePointType¶
-
HumanBuilder.
SetReferencePointType
¶ Sets the reference point type
Signature
SetReferencePointType(referencePointType)
Parameters: referencePointType ( NXOpen.HumanDataReferencePointType
) – Type of reference point typeNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetResetPosture¶
-
HumanBuilder.
SetResetPosture
¶ Set flag for reset posture
Signature
SetResetPosture()
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetResetSegment¶
-
HumanBuilder.
SetResetSegment
¶ Set flag for reset segment
Signature
SetResetSegment()
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetSegmentScalingData¶
-
HumanBuilder.
SetSegmentScalingData
¶ Set segment data for segment scaling
Signature
SetSegmentScalingData(segmentName, depthFactor, breadthFactor, lengthFactor)
Parameters: - segmentName (
NXOpen.HumanDataSegmentScalingType
) – Segment name - depthFactor (float) – Depth factor value for segment scaling
- breadthFactor (float) – Breadth factor value for segment scaling
- lengthFactor (float) – Length factor value for segment scaling
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- segmentName (
SetSegmentSitesName¶
-
HumanBuilder.
SetSegmentSitesName
¶ Set the segment site name of edit human display.
Signature
SetSegmentSitesName(segmentSitesName)
Parameters: segmentSitesName (list of str) – the segment sites name New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetShowSkeleton¶
-
HumanBuilder.
SetShowSkeleton
¶ Set flag for show human skeleton
Signature
SetShowSkeleton(showSkeleton)
Parameters: showSkeleton (bool) – Flag for showing skeleton New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
SetStatureData¶
-
HumanBuilder.
SetStatureData
¶ Sets human stature data
Signature
SetStatureData(statureType, stature, statureUnit)
Parameters: - statureType (
NXOpen.HumanDataStatureType
) – Flag for percentile stature in database or actual stature measure - stature (float) – Stature value
- statureUnit (
NXOpen.HumanDataStatureUnitType
) – Unit for stature
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- statureType (
SetWeightData¶
-
HumanBuilder.
SetWeightData
¶ Sets human weight data
Signature
SetWeightData(weightType, weight, weightUnit)
Parameters: - weightType (
NXOpen.HumanDataWeightType
) – Flag for percentile weight in database or actual weight value - weight (float) – Weight value
- weightUnit (
NXOpen.HumanDataWeightUnitType
) – Unit for weight
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”), ug_human (“Human Modelling”)
- weightType (
Validate¶
-
HumanBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.