HumanHandsDialogBuilder Class¶
-
class
NXOpen.
HumanHandsDialogBuilder
¶ Bases:
NXOpen.Builder
Dialog for creating and editing standalone/”disembodied” hand figures
To create a new instance of this class, use
NXOpen.Features.HumanBuilder.CreateHumanHandsDialogBuilder()
Default values.
Property Value Aperture 1 BreadthPercentile P75 BreadthValue 9 Database Ansur Gender Male GloveThickness 1 IncludeForearm 0 LengthPercentile P75 LengthValue 20 Side Right Style Gloves New in version NX11.0.2.
Properties¶
Property | Description |
---|---|
Aperture | Returns or sets the aperture |
BreadthPercentile | Returns or sets the breadth percentile |
BreadthValue | Returns or sets the breadth value |
Database | Returns or sets the database |
Gender | Returns or sets the gender |
GloveThickness | Returns or sets the glove thickness |
IncludeForearm | Returns or sets the include forearm |
LengthPercentile | Returns or sets the length percentile |
LengthValue | Returns or sets the length value |
ShapeName | Returns or sets the shape name |
Side | Returns or sets the side |
Style | Returns or sets the style |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
JointDialogButton | TODO: fill in a description for this |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateHandPropsButton | TODO: fill in a description for this |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
HumanHandsDialogBuilderBreadthType Enumeration | hand breadth for scaling |
HumanHandsDialogBuilderDatabaseType Enumeration | database used for scaling. |
HumanHandsDialogBuilderGenderType Enumeration | gender of hand figure, also used for scaling |
HumanHandsDialogBuilderHandType Enumeration | left or right hand |
HumanHandsDialogBuilderLengthType Enumeration | hand length for scaling |
HumanHandsDialogBuilderStyleType Enumeration | gloved or bare hand |
Property Detail¶
Aperture¶
-
HumanHandsDialogBuilder.
Aperture
¶ Returns or sets the aperture
-------------------------------------
Getter Method
Signature
Aperture
Returns: Return type: float New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
Aperture
Parameters: aperture (float) – New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
BreadthPercentile¶
-
HumanHandsDialogBuilder.
BreadthPercentile
¶ Returns or sets the breadth percentile
-------------------------------------
Getter Method
Signature
BreadthPercentile
Returns: Return type: NXOpen.HumanHandsDialogBuilderBreadthType
New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
BreadthPercentile
Parameters: breadthPercentile ( NXOpen.HumanHandsDialogBuilderBreadthType
) –New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
BreadthValue¶
-
HumanHandsDialogBuilder.
BreadthValue
¶ Returns or sets the breadth value
-------------------------------------
Getter Method
Signature
BreadthValue
Returns: Return type: float New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
BreadthValue
Parameters: breadthValue (float) – New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
Database¶
-
HumanHandsDialogBuilder.
Database
¶ Returns or sets the database
-------------------------------------
Getter Method
Signature
Database
Returns: Return type: NXOpen.HumanHandsDialogBuilderDatabaseType
New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
Database
Parameters: database ( NXOpen.HumanHandsDialogBuilderDatabaseType
) –New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
Gender¶
-
HumanHandsDialogBuilder.
Gender
¶ Returns or sets the gender
-------------------------------------
Getter Method
Signature
Gender
Returns: Return type: NXOpen.HumanHandsDialogBuilderGenderType
New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
Gender
Parameters: gender ( NXOpen.HumanHandsDialogBuilderGenderType
) –New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
GloveThickness¶
-
HumanHandsDialogBuilder.
GloveThickness
¶ Returns or sets the glove thickness
-------------------------------------
Getter Method
Signature
GloveThickness
Returns: Return type: float New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
GloveThickness
Parameters: gloveThickness (float) – New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
IncludeForearm¶
-
HumanHandsDialogBuilder.
IncludeForearm
¶ Returns or sets the include forearm
-------------------------------------
Getter Method
Signature
IncludeForearm
Returns: Return type: bool New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
IncludeForearm
Parameters: includeForearm (bool) – New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
LengthPercentile¶
-
HumanHandsDialogBuilder.
LengthPercentile
¶ Returns or sets the length percentile
-------------------------------------
Getter Method
Signature
LengthPercentile
Returns: Return type: NXOpen.HumanHandsDialogBuilderLengthType
New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
LengthPercentile
Parameters: lengthPercentile ( NXOpen.HumanHandsDialogBuilderLengthType
) –New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
LengthValue¶
-
HumanHandsDialogBuilder.
LengthValue
¶ Returns or sets the length value
-------------------------------------
Getter Method
Signature
LengthValue
Returns: Return type: float New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
LengthValue
Parameters: lengthValue (float) – New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
ShapeName¶
-
HumanHandsDialogBuilder.
ShapeName
¶ Returns or sets the shape name
-------------------------------------
Getter Method
Signature
ShapeName
Returns: Return type: str New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
ShapeName
Parameters: shapeName (str) – New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
Side¶
-
HumanHandsDialogBuilder.
Side
¶ Returns or sets the side
-------------------------------------
Getter Method
Signature
Side
Returns: Return type: NXOpen.HumanHandsDialogBuilderHandType
New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
Side
Parameters: side ( NXOpen.HumanHandsDialogBuilderHandType
) –New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
Style¶
-
HumanHandsDialogBuilder.
Style
¶ Returns or sets the style
-------------------------------------
Getter Method
Signature
Style
Returns: Return type: NXOpen.HumanHandsDialogBuilderStyleType
New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
-------------------------------------
Setter Method
Signature
Style
Parameters: style ( NXOpen.HumanHandsDialogBuilderStyleType
) –New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
Method Detail¶
JointDialogButton¶
-
HumanHandsDialogBuilder.
JointDialogButton
¶ TODO: fill in a description for this
Signature
JointDialogButton()
New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
UpdateHandPropsButton¶
-
HumanHandsDialogBuilder.
UpdateHandPropsButton
¶ TODO: fill in a description for this
Signature
UpdateHandPropsButton()
New in version NX11.0.2.
License requirements: ug_human (“Human Modelling”)
Validate¶
-
HumanHandsDialogBuilder.
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.