NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::HumanHandsDialogBuilder Class Reference

Dialog for creating and editing standalone/"disembodied" hand figures
To create a new instance of this class, use NXOpen::Features::HumanBuilder::CreateHumanHandsDialogBuilder
Default values. More...

Inheritance diagram for NXOpen::HumanHandsDialogBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BreadthType {
  BreadthTypeP5, BreadthTypeP25, BreadthTypeP50, BreadthTypeP75,
  BreadthTypeP95
}
 hand breadth for scaling More...
 
enum  DatabaseType { DatabaseTypeAnsur, DatabaseTypeAnsur2, DatabaseTypeNhanes, DatabaseTypeNhanes2014 }
 database used for scaling. More...
 
enum  GenderType { GenderTypeMale, GenderTypeFemale }
 gender of hand figure, also used for scaling More...
 
enum  HandType { HandTypeRight, HandTypeLeft }
 left or right hand More...
 
enum  LengthType {
  LengthTypeP5, LengthTypeP25, LengthTypeP50, LengthTypeP75,
  LengthTypeP95
}
 hand length for scaling More...
 
enum  StyleType { StyleTypeGloves, StyleTypeBareHands }
 gloved or bare hand More...
 

Public Member Functions

double Aperture ()
 Returns the aperture
Created in NX11.0.2. More...
 
NXOpen::HumanHandsDialogBuilder::BreadthType BreadthPercentile ()
 Returns the breadth percentile
Created in NX11.0.2. More...
 
double BreadthValue ()
 Returns the breadth value
Created in NX11.0.2. More...
 
NXOpen::HumanHandsDialogBuilder::DatabaseType Database ()
 Returns the database
Created in NX11.0.2. More...
 
NXOpen::HumanHandsDialogBuilder::GenderType Gender ()
 Returns the gender
Created in NX11.0.2. More...
 
double GloveThickness ()
 Returns the glove thickness
Created in NX11.0.2. More...
 
bool IncludeForearm ()
 Returns the include forearm
Created in NX11.0.2. More...
 
void JointDialogButton ()
 TODO: fill in a description for this
Created in NX11.0.2. More...
 
NXOpen::HumanHandsDialogBuilder::LengthType LengthPercentile ()
 Returns the length percentile
Created in NX11.0.2. More...
 
double LengthValue ()
 Returns the length value
Created in NX11.0.2. More...
 
void SetAperture (double aperture)
 Sets the aperture
Created in NX11.0.2. More...
 
void SetBreadthPercentile (NXOpen::HumanHandsDialogBuilder::BreadthType breadthPercentile)
 Sets the breadth percentile
Created in NX11.0.2. More...
 
void SetBreadthValue (double breadthValue)
 Sets the breadth value
Created in NX11.0.2. More...
 
void SetDatabase (NXOpen::HumanHandsDialogBuilder::DatabaseType database)
 Sets the database
Created in NX11.0.2. More...
 
void SetGender (NXOpen::HumanHandsDialogBuilder::GenderType gender)
 Sets the gender
Created in NX11.0.2. More...
 
void SetGloveThickness (double gloveThickness)
 Sets the glove thickness
Created in NX11.0.2. More...
 
void SetIncludeForearm (bool includeForearm)
 Sets the include forearm
Created in NX11.0.2. More...
 
void SetLengthPercentile (NXOpen::HumanHandsDialogBuilder::LengthType lengthPercentile)
 Sets the length percentile
Created in NX11.0.2. More...
 
void SetLengthValue (double lengthValue)
 Sets the length value
Created in NX11.0.2. More...
 
void SetShapeName (const NXString &shapeName)
 Sets the shape name
Created in NX11.0.2. More...
 
void SetShapeName (const char *shapeName)
 Sets the shape name
Created in NX11.0.2. More...
 
void SetSide (NXOpen::HumanHandsDialogBuilder::HandType side)
 Sets the side
Created in NX11.0.2. More...
 
void SetStyle (NXOpen::HumanHandsDialogBuilder::StyleType style)
 Sets the style
Created in NX11.0.2. More...
 
NXString ShapeName ()
 Returns the shape name
Created in NX11.0.2. More...
 
NXOpen::HumanHandsDialogBuilder::HandType Side ()
 Returns the side
Created in NX11.0.2. More...
 
NXOpen::HumanHandsDialogBuilder::StyleType Style ()
 Returns the style
Created in NX11.0.2. More...
 
void UpdateHandPropsButton ()
 TODO: fill in a description for this
Created in NX11.0.2. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


Created in NX11.0.2.

Member Enumeration Documentation

hand breadth for scaling

Enumerator
BreadthTypeP5 

p5

BreadthTypeP25 

p25

BreadthTypeP50 

p50

BreadthTypeP75 

p75

BreadthTypeP95 

p95

database used for scaling.

likely to be dynamically generated at runtime

Enumerator
DatabaseTypeAnsur 

ansur

DatabaseTypeAnsur2 

ansur2

DatabaseTypeNhanes 

nhanes

DatabaseTypeNhanes2014 

nhanes2014

gender of hand figure, also used for scaling

Enumerator
GenderTypeMale 

male

GenderTypeFemale 

female

left or right hand

Enumerator
HandTypeRight 

right

HandTypeLeft 

left

hand length for scaling

Enumerator
LengthTypeP5 

p5

LengthTypeP25 

p25

LengthTypeP50 

p50

LengthTypeP75 

p75

LengthTypeP95 

p95

gloved or bare hand

Enumerator
StyleTypeGloves 

gloves

StyleTypeBareHands 

bare hands

Member Function Documentation

double NXOpen::HumanHandsDialogBuilder::Aperture ( )

Returns the aperture
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

NXOpen::HumanHandsDialogBuilder::BreadthType NXOpen::HumanHandsDialogBuilder::BreadthPercentile ( )

Returns the breadth percentile
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

double NXOpen::HumanHandsDialogBuilder::BreadthValue ( )

Returns the breadth value
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

NXOpen::HumanHandsDialogBuilder::DatabaseType NXOpen::HumanHandsDialogBuilder::Database ( )

Returns the database
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

NXOpen::HumanHandsDialogBuilder::GenderType NXOpen::HumanHandsDialogBuilder::Gender ( )

Returns the gender
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

double NXOpen::HumanHandsDialogBuilder::GloveThickness ( )

Returns the glove thickness
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

bool NXOpen::HumanHandsDialogBuilder::IncludeForearm ( )

Returns the include forearm
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

void NXOpen::HumanHandsDialogBuilder::JointDialogButton ( )

TODO: fill in a description for this
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

NXOpen::HumanHandsDialogBuilder::LengthType NXOpen::HumanHandsDialogBuilder::LengthPercentile ( )

Returns the length percentile
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

double NXOpen::HumanHandsDialogBuilder::LengthValue ( )

Returns the length value
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

void NXOpen::HumanHandsDialogBuilder::SetAperture ( double  aperture)

Sets the aperture
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
apertureaperture
void NXOpen::HumanHandsDialogBuilder::SetBreadthPercentile ( NXOpen::HumanHandsDialogBuilder::BreadthType  breadthPercentile)

Sets the breadth percentile
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
breadthPercentilebreadthpercentile
void NXOpen::HumanHandsDialogBuilder::SetBreadthValue ( double  breadthValue)

Sets the breadth value
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
breadthValuebreadthvalue
void NXOpen::HumanHandsDialogBuilder::SetDatabase ( NXOpen::HumanHandsDialogBuilder::DatabaseType  database)

Sets the database
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
databasedatabase
void NXOpen::HumanHandsDialogBuilder::SetGender ( NXOpen::HumanHandsDialogBuilder::GenderType  gender)

Sets the gender
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
gendergender
void NXOpen::HumanHandsDialogBuilder::SetGloveThickness ( double  gloveThickness)

Sets the glove thickness
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
gloveThicknessglovethickness
void NXOpen::HumanHandsDialogBuilder::SetIncludeForearm ( bool  includeForearm)

Sets the include forearm
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
includeForearmincludeforearm
void NXOpen::HumanHandsDialogBuilder::SetLengthPercentile ( NXOpen::HumanHandsDialogBuilder::LengthType  lengthPercentile)

Sets the length percentile
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
lengthPercentilelengthpercentile
void NXOpen::HumanHandsDialogBuilder::SetLengthValue ( double  lengthValue)

Sets the length value
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
lengthValuelengthvalue
void NXOpen::HumanHandsDialogBuilder::SetShapeName ( const NXString shapeName)

Sets the shape name
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
shapeNameshapename
void NXOpen::HumanHandsDialogBuilder::SetShapeName ( const char *  shapeName)

Sets the shape name
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
shapeNameshapename
void NXOpen::HumanHandsDialogBuilder::SetSide ( NXOpen::HumanHandsDialogBuilder::HandType  side)

Sets the side
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
sideside
void NXOpen::HumanHandsDialogBuilder::SetStyle ( NXOpen::HumanHandsDialogBuilder::StyleType  style)

Sets the style
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

Parameters
stylestyle
NXString NXOpen::HumanHandsDialogBuilder::ShapeName ( )

Returns the shape name
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

NXOpen::HumanHandsDialogBuilder::HandType NXOpen::HumanHandsDialogBuilder::Side ( )

Returns the side
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

NXOpen::HumanHandsDialogBuilder::StyleType NXOpen::HumanHandsDialogBuilder::Style ( )

Returns the style
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")

void NXOpen::HumanHandsDialogBuilder::UpdateHandPropsButton ( )

TODO: fill in a description for this
Created in NX11.0.2.



License requirements : ug_human ("Human Modelling")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.