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

the builder for Drafting Automation Preferences
To create a new instance of this class, use NXOpen::Drafting::AutomationManager::CreatePreferencesBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::Drafting::AutomationPreferencesBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool AllowFeetInchFractionForDimensionGreaterThan ()
 Returns the determination of the feet inch fraction display for dimension greater than
Created in NX8.0.0. More...
 
bool AllowInchFractionToNearest ()
 Returns the determination of the display for inch fraction to nearest
Created in NX8.0.0. More...
 
bool AnnotationInsideGeometry ()
 Returns the annotation inside geometry
Created in NX8.0.0. More...
 
bool DisplayRegion ()
 Returns the display in non template
Created in NX8.0.0. More...
 
bool DisplayRegionLabel ()
 Returns the display region label
Created in NX8.0.0. More...
 
double DistanceBetweenAnnotations ()
 Returns the distance between annotations
Created in NX8.0.0. More...
 
double EqualDimensionCompareTolerance ()
 Returns the equal dimension compare tolerance
Created in NX8.0.0. More...
 
double FeetInchFractionForDimensionGreaterThan ()
 Returns the feet inch fraction for dimension greater than
Created in NX8.0.0. More...
 
std::vector< NXStringGetRulesList ()
 Get the ordered rules list. More...
 
bool HideFeetInchMark ()
 Returns the hide feet inch mark
Created in NX8.0.0. More...
 
double InchFractionToNearest ()
 Returns the inch fraction to nearest
Created in NX8.0.0. More...
 
double MaximumDistanceToGeometry ()
 Returns the maximum distance to geometry
Created in NX8.0.0. More...
 
double MinimumDistanceToGeometry ()
 Returns the minimum distance to geometry
Created in NX8.0.0. More...
 
double ReferenceGeometrySearchDistance ()
 Returns the reference geometry search distance
Created in NX8.0.0. More...
 
NXOpen::NXColorRegionColor ()
 Returns the region color
Created in NX8.0.0. More...
 
NXOpen::Preferences::PartDrafting::FontType RegionFont ()
 Returns the region font
Created in NX8.0.0. More...
 
NXOpen::Preferences::PartDrafting::WidthType RegionWidth ()
 Returns the region width
Created in NX8.0.0. More...
 
NXOpen::NXColorSecondaryContentHiddenLineColor ()
 Returns the secondary content hidden line color
Created in NX8.0.0. More...
 
NXOpen::Preferences::PartDrafting::FontType SecondaryContentHiddenLineFont ()
 Returns the secondary content hidden line font
Created in NX8.0.0. More...
 
NXOpen::Preferences::PartDrafting::WidthType SecondaryContentHiddenLineWidth ()
 Returns the secondary content hidden line width
Created in NX8.0.0. More...
 
NXOpen::NXColorSecondaryContentVisibleLineColor ()
 Returns the secondary content visible line color
Created in NX8.0.0. More...
 
NXOpen::Preferences::PartDrafting::FontType SecondaryContentVisibleLineFont ()
 Returns the secondary content visible line font
Created in NX8.0.0. More...
 
NXOpen::Preferences::PartDrafting::WidthType SecondaryContentVisibleLineWidth ()
 Returns the secondary content visible line width
Created in NX8.0.0. More...
 
void SetAllowFeetInchFractionForDimensionGreaterThan (bool allowFeetInchFractionForDimensionGreaterThan)
 Sets the determination of the feet inch fraction display for dimension greater than
Created in NX8.0.0. More...
 
void SetAllowInchFractionToNearest (bool allowInchFractionToNearest)
 Sets the determination of the display for inch fraction to nearest
Created in NX8.0.0. More...
 
void SetAnnotationInsideGeometry (bool annotationInsideGeometry)
 Sets the annotation inside geometry
Created in NX8.0.0. More...
 
void SetDisplayRegion (bool displayRegion)
 Sets the display in non template
Created in NX8.0.0. More...
 
void SetDisplayRegionLabel (bool displayRegionLabel)
 Sets the display region label
Created in NX8.0.0. More...
 
void SetDistanceBetweenAnnotations (double distanceBetweenAnnotations)
 Sets the distance between annotations
Created in NX8.0.0. More...
 
void SetEqualDimensionCompareTolerance (double equalDimensionCompareTolerance)
 Sets the equal dimension compare tolerance
Created in NX8.0.0. More...
 
void SetFeetInchFractionForDimensionGreaterThan (double feetInchFractionForDimensionGreaterThan)
 Sets the feet inch fraction for dimension greater than
Created in NX8.0.0. More...
 
void SetHideFeetInchMark (bool hideFeetInchMark)
 Sets the hide feet inch mark
Created in NX8.0.0. More...
 
void SetInchFractionToNearest (double inchFractionToNearest)
 Sets the inch fraction to nearest
Created in NX8.0.0. More...
 
void SetMaximumDistanceToGeometry (double maximumDistanceToGeometry)
 Sets the maximum distance to geometry
Created in NX8.0.0. More...
 
void SetMinimumDistanceToGeometry (double minimumDistanceToGeometry)
 Sets the minimum distance to geometry
Created in NX8.0.0. More...
 
void SetReferenceGeometrySearchDistance (double referenceGeometrySearchDistance)
 Sets the reference geometry search distance
Created in NX8.0.0. More...
 
void SetRegionColor (NXOpen::NXColor *regionColor)
 Sets the region color
Created in NX8.0.0. More...
 
void SetRegionFont (NXOpen::Preferences::PartDrafting::FontType regionFont)
 Sets the region font
Created in NX8.0.0. More...
 
void SetRegionWidth (NXOpen::Preferences::PartDrafting::WidthType regionWidth)
 Sets the region width
Created in NX8.0.0. More...
 
void SetRulesList (std::vector< NXString > &rules)
 Set the ordered rules list
Created in NX8.0.0. More...
 
void SetSecondaryContentHiddenLineColor (NXOpen::NXColor *secondaryContentHiddenLineColor)
 Sets the secondary content hidden line color
Created in NX8.0.0. More...
 
void SetSecondaryContentHiddenLineFont (NXOpen::Preferences::PartDrafting::FontType secondaryContentHiddenLineFont)
 Sets the secondary content hidden line font
Created in NX8.0.0. More...
 
void SetSecondaryContentHiddenLineWidth (NXOpen::Preferences::PartDrafting::WidthType secondaryContentHiddenLineWidth)
 Sets the secondary content hidden line width
Created in NX8.0.0. More...
 
void SetSecondaryContentVisibleLineColor (NXOpen::NXColor *secondaryContentVisibleLineColor)
 Sets the secondary content visible line color
Created in NX8.0.0. More...
 
void SetSecondaryContentVisibleLineFont (NXOpen::Preferences::PartDrafting::FontType secondaryContentVisibleLineFont)
 Sets the secondary content visible line font
Created in NX8.0.0. More...
 
void SetSecondaryContentVisibleLineWidth (NXOpen::Preferences::PartDrafting::WidthType secondaryContentVisibleLineWidth)
 Sets the secondary content visible line width
Created in NX8.0.0. 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

the builder for Drafting Automation Preferences
To create a new instance of this class, use NXOpen::Drafting::AutomationManager::CreatePreferencesBuilder

Created in NX8.0.0.


Member Function Documentation

bool NXOpen::Drafting::AutomationPreferencesBuilder::AllowFeetInchFractionForDimensionGreaterThan ( )

Returns the determination of the feet inch fraction display for dimension greater than
Created in NX8.0.0.



License requirements : None

bool NXOpen::Drafting::AutomationPreferencesBuilder::AllowInchFractionToNearest ( )

Returns the determination of the display for inch fraction to nearest
Created in NX8.0.0.



License requirements : None

bool NXOpen::Drafting::AutomationPreferencesBuilder::AnnotationInsideGeometry ( )

Returns the annotation inside geometry
Created in NX8.0.0.



License requirements : None

bool NXOpen::Drafting::AutomationPreferencesBuilder::DisplayRegion ( )

Returns the display in non template
Created in NX8.0.0.



License requirements : None

bool NXOpen::Drafting::AutomationPreferencesBuilder::DisplayRegionLabel ( )

Returns the display region label
Created in NX8.0.0.



License requirements : None

double NXOpen::Drafting::AutomationPreferencesBuilder::DistanceBetweenAnnotations ( )

Returns the distance between annotations
Created in NX8.0.0.



License requirements : None

double NXOpen::Drafting::AutomationPreferencesBuilder::EqualDimensionCompareTolerance ( )

Returns the equal dimension compare tolerance
Created in NX8.0.0.



License requirements : None

double NXOpen::Drafting::AutomationPreferencesBuilder::FeetInchFractionForDimensionGreaterThan ( )

Returns the feet inch fraction for dimension greater than
Created in NX8.0.0.



License requirements : None

std::vector<NXString> NXOpen::Drafting::AutomationPreferencesBuilder::GetRulesList ( )

Get the ordered rules list.

Returns
Rules list
Created in NX8.0.0.

License requirements : None
bool NXOpen::Drafting::AutomationPreferencesBuilder::HideFeetInchMark ( )

Returns the hide feet inch mark
Created in NX8.0.0.



License requirements : None

double NXOpen::Drafting::AutomationPreferencesBuilder::InchFractionToNearest ( )

Returns the inch fraction to nearest
Created in NX8.0.0.



License requirements : None

double NXOpen::Drafting::AutomationPreferencesBuilder::MaximumDistanceToGeometry ( )

Returns the maximum distance to geometry
Created in NX8.0.0.



License requirements : None

double NXOpen::Drafting::AutomationPreferencesBuilder::MinimumDistanceToGeometry ( )

Returns the minimum distance to geometry
Created in NX8.0.0.



License requirements : None

double NXOpen::Drafting::AutomationPreferencesBuilder::ReferenceGeometrySearchDistance ( )

Returns the reference geometry search distance
Created in NX8.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::Drafting::AutomationPreferencesBuilder::RegionColor ( )

Returns the region color
Created in NX8.0.0.



License requirements : None

NXOpen::Preferences::PartDrafting::FontType NXOpen::Drafting::AutomationPreferencesBuilder::RegionFont ( )

Returns the region font
Created in NX8.0.0.



License requirements : None

NXOpen::Preferences::PartDrafting::WidthType NXOpen::Drafting::AutomationPreferencesBuilder::RegionWidth ( )

Returns the region width
Created in NX8.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::Drafting::AutomationPreferencesBuilder::SecondaryContentHiddenLineColor ( )

Returns the secondary content hidden line color
Created in NX8.0.0.



License requirements : None

NXOpen::Preferences::PartDrafting::FontType NXOpen::Drafting::AutomationPreferencesBuilder::SecondaryContentHiddenLineFont ( )

Returns the secondary content hidden line font
Created in NX8.0.0.



License requirements : None

NXOpen::Preferences::PartDrafting::WidthType NXOpen::Drafting::AutomationPreferencesBuilder::SecondaryContentHiddenLineWidth ( )

Returns the secondary content hidden line width
Created in NX8.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::Drafting::AutomationPreferencesBuilder::SecondaryContentVisibleLineColor ( )

Returns the secondary content visible line color
Created in NX8.0.0.



License requirements : None

NXOpen::Preferences::PartDrafting::FontType NXOpen::Drafting::AutomationPreferencesBuilder::SecondaryContentVisibleLineFont ( )

Returns the secondary content visible line font
Created in NX8.0.0.



License requirements : None

NXOpen::Preferences::PartDrafting::WidthType NXOpen::Drafting::AutomationPreferencesBuilder::SecondaryContentVisibleLineWidth ( )

Returns the secondary content visible line width
Created in NX8.0.0.



License requirements : None

void NXOpen::Drafting::AutomationPreferencesBuilder::SetAllowFeetInchFractionForDimensionGreaterThan ( bool  allowFeetInchFractionForDimensionGreaterThan)

Sets the determination of the feet inch fraction display for dimension greater than
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
allowFeetInchFractionForDimensionGreaterThanallowfeetinchfractionfordimensiongreaterthan
void NXOpen::Drafting::AutomationPreferencesBuilder::SetAllowInchFractionToNearest ( bool  allowInchFractionToNearest)

Sets the determination of the display for inch fraction to nearest
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
allowInchFractionToNearestallowinchfractiontonearest
void NXOpen::Drafting::AutomationPreferencesBuilder::SetAnnotationInsideGeometry ( bool  annotationInsideGeometry)

Sets the annotation inside geometry
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
annotationInsideGeometryannotationinsidegeometry
void NXOpen::Drafting::AutomationPreferencesBuilder::SetDisplayRegion ( bool  displayRegion)

Sets the display in non template
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
displayRegiondisplayregion
void NXOpen::Drafting::AutomationPreferencesBuilder::SetDisplayRegionLabel ( bool  displayRegionLabel)

Sets the display region label
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
displayRegionLabeldisplayregionlabel
void NXOpen::Drafting::AutomationPreferencesBuilder::SetDistanceBetweenAnnotations ( double  distanceBetweenAnnotations)

Sets the distance between annotations
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
distanceBetweenAnnotationsdistancebetweenannotations
void NXOpen::Drafting::AutomationPreferencesBuilder::SetEqualDimensionCompareTolerance ( double  equalDimensionCompareTolerance)

Sets the equal dimension compare tolerance
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
equalDimensionCompareToleranceequaldimensioncomparetolerance
void NXOpen::Drafting::AutomationPreferencesBuilder::SetFeetInchFractionForDimensionGreaterThan ( double  feetInchFractionForDimensionGreaterThan)

Sets the feet inch fraction for dimension greater than
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
feetInchFractionForDimensionGreaterThanfeetinchfractionfordimensiongreaterthan
void NXOpen::Drafting::AutomationPreferencesBuilder::SetHideFeetInchMark ( bool  hideFeetInchMark)

Sets the hide feet inch mark
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
hideFeetInchMarkhidefeetinchmark
void NXOpen::Drafting::AutomationPreferencesBuilder::SetInchFractionToNearest ( double  inchFractionToNearest)

Sets the inch fraction to nearest
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
inchFractionToNearestinchfractiontonearest
void NXOpen::Drafting::AutomationPreferencesBuilder::SetMaximumDistanceToGeometry ( double  maximumDistanceToGeometry)

Sets the maximum distance to geometry
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
maximumDistanceToGeometrymaximumdistancetogeometry
void NXOpen::Drafting::AutomationPreferencesBuilder::SetMinimumDistanceToGeometry ( double  minimumDistanceToGeometry)

Sets the minimum distance to geometry
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
minimumDistanceToGeometryminimumdistancetogeometry
void NXOpen::Drafting::AutomationPreferencesBuilder::SetReferenceGeometrySearchDistance ( double  referenceGeometrySearchDistance)

Sets the reference geometry search distance
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
referenceGeometrySearchDistancereferencegeometrysearchdistance
void NXOpen::Drafting::AutomationPreferencesBuilder::SetRegionColor ( NXOpen::NXColor regionColor)

Sets the region color
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
regionColorregioncolor
void NXOpen::Drafting::AutomationPreferencesBuilder::SetRegionFont ( NXOpen::Preferences::PartDrafting::FontType  regionFont)

Sets the region font
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
regionFontregionfont
void NXOpen::Drafting::AutomationPreferencesBuilder::SetRegionWidth ( NXOpen::Preferences::PartDrafting::WidthType  regionWidth)

Sets the region width
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
regionWidthregionwidth
void NXOpen::Drafting::AutomationPreferencesBuilder::SetRulesList ( std::vector< NXString > &  rules)

Set the ordered rules list
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
rulesRules list
void NXOpen::Drafting::AutomationPreferencesBuilder::SetSecondaryContentHiddenLineColor ( NXOpen::NXColor secondaryContentHiddenLineColor)

Sets the secondary content hidden line color
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
secondaryContentHiddenLineColorsecondarycontenthiddenlinecolor
void NXOpen::Drafting::AutomationPreferencesBuilder::SetSecondaryContentHiddenLineFont ( NXOpen::Preferences::PartDrafting::FontType  secondaryContentHiddenLineFont)

Sets the secondary content hidden line font
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
secondaryContentHiddenLineFontsecondarycontenthiddenlinefont
void NXOpen::Drafting::AutomationPreferencesBuilder::SetSecondaryContentHiddenLineWidth ( NXOpen::Preferences::PartDrafting::WidthType  secondaryContentHiddenLineWidth)

Sets the secondary content hidden line width
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
secondaryContentHiddenLineWidthsecondarycontenthiddenlinewidth
void NXOpen::Drafting::AutomationPreferencesBuilder::SetSecondaryContentVisibleLineColor ( NXOpen::NXColor secondaryContentVisibleLineColor)

Sets the secondary content visible line color
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
secondaryContentVisibleLineColorsecondarycontentvisiblelinecolor
void NXOpen::Drafting::AutomationPreferencesBuilder::SetSecondaryContentVisibleLineFont ( NXOpen::Preferences::PartDrafting::FontType  secondaryContentVisibleLineFont)

Sets the secondary content visible line font
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
secondaryContentVisibleLineFontsecondarycontentvisiblelinefont
void NXOpen::Drafting::AutomationPreferencesBuilder::SetSecondaryContentVisibleLineWidth ( NXOpen::Preferences::PartDrafting::WidthType  secondaryContentVisibleLineWidth)

Sets the secondary content visible line width
Created in NX8.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
secondaryContentVisibleLineWidthsecondarycontentvisiblelinewidth

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