NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::SheetMetal::FlatPatternSettings Class Reference

Provides access to object and callout properties for sheet-metal data in flat pattern views on drawings. More...

Inheritance diagram for NXOpen::SheetMetal::FlatPatternSettings:
NXOpen::TaggedObject

List of all members.

Classes

struct  FlatPatternCalloutTypeDisplay
 The members of the following structure are the display data for a callout in a flat pattern drawing member view. More...
struct  FlatPatternObjectTypeDisplay
 The members of the following structure are the display data for an object in a flat pattern drawing member view. More...

Public Types

enum  FlatPatternObjectType {
  FlatPatternObjectTypeBendCenterLine, FlatPatternObjectTypeBendUpCenterLine, FlatPatternObjectTypeBendDownCenterLine, FlatPatternObjectTypeBendTangentLine,
  FlatPatternObjectTypeOuterMoldLine, FlatPatternObjectTypeInnerMoldLine, FlatPatternObjectTypeExteriorCurves, FlatPatternObjectTypeInteriorCurves,
  FlatPatternObjectTypeInteriorCutoutCurves, FlatPatternObjectTypeInteriorFeatureCurves, FlatPatternObjectTypeLighteningHoleCenter, FlatPatternObjectTypeJoggleLine,
  FlatPatternObjectTypeAddedTopGeometry, FlatPatternObjectTypeAddedBottomGeometry, FlatPatternObjectTypeToolMarker
}
 The members of the following enumerated type are used to identify object types to the FlatPatternView API. More...

Public Member Functions

void GetFlatPatternAllCalloutTypeDisplay (std::vector< NXOpen::SheetMetal::FlatPatternSettings::FlatPatternCalloutTypeDisplay > &displayData)
 Returns the dialog names, identifiers, and enabled status for all the available callout types.
void GetFlatPatternAllObjectTypeDisplay (std::vector< NXOpen::SheetMetal::FlatPatternSettings::FlatPatternObjectTypeDisplay > &displayData)
 Returns the types, colors, fonts, widths, and enabled status for all the available object types.
NXOpen::SheetMetal::FlatPatternSettings::FlatPatternCalloutTypeDisplay GetFlatPatternCalloutTypeDisplay (const NXString &calloutType)
 Returns the display data for a callout type.
NXOpen::SheetMetal::FlatPatternSettings::FlatPatternObjectTypeDisplay GetFlatPatternObjectTypeDisplay (NXOpen::SheetMetal::FlatPatternSettings::FlatPatternObjectType objectType)
 Returns the display data for a flat pattern object type.
void SetFlatPatternCalloutTypeDisplay (const NXString &calloutType, const NXOpen::SheetMetal::FlatPatternSettings::FlatPatternCalloutTypeDisplay &displayData)
 Sets the display data for a callout type.
void SetFlatPatternObjectTypeDisplay (NXOpen::SheetMetal::FlatPatternSettings::FlatPatternObjectType objectType, const NXOpen::SheetMetal::FlatPatternSettings::FlatPatternObjectTypeDisplay &displayData)
 Sets the display data for a flat pattern object type.

Detailed Description

Provides access to object and callout properties for sheet-metal data in flat pattern views on drawings.

The class is created upon a query to obtain the FlatPatternView object from either a view (style) or a part (preferences).
This class is not created directly by the user.

Created in NX5.0.0.


Member Enumeration Documentation

The members of the following enumerated type are used to identify object types to the FlatPatternView API.

These are not the usual NX object types; they are ordinary NX objects that are known to the flat pattern feature for the type of outline they provide to a bend region, joggle region, or lightening hole.

Enumerator:
FlatPatternObjectTypeBendCenterLine 

Deprecated.

FlatPatternObjectTypeBendUpCenterLine 

bend up center line

FlatPatternObjectTypeBendDownCenterLine 

bend down center line

FlatPatternObjectTypeBendTangentLine 

bend tangent line

FlatPatternObjectTypeOuterMoldLine 

outer mold line

FlatPatternObjectTypeInnerMoldLine 

inner mold line

FlatPatternObjectTypeExteriorCurves 

exterior curves

FlatPatternObjectTypeInteriorCurves 

Deprecated.

FlatPatternObjectTypeInteriorCutoutCurves 

interior cutout curves

FlatPatternObjectTypeInteriorFeatureCurves 

interior feature curves

FlatPatternObjectTypeLighteningHoleCenter 

lightening hole center

FlatPatternObjectTypeJoggleLine 

joggle line

FlatPatternObjectTypeAddedTopGeometry 

added top geometry

FlatPatternObjectTypeAddedBottomGeometry 

added bottom geometry

FlatPatternObjectTypeToolMarker 

tool marker


Member Function Documentation

Returns the dialog names, identifiers, and enabled status for all the available callout types.


Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
displayDataArray of structures with the callout type display data.

Returns the types, colors, fonts, widths, and enabled status for all the available object types.


Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
displayDataArray of structures with the object type display data.

Returns the display data for a callout type.

The name member of the SheetMetal::FlatPatternSettings::FlatPatternCalloutTypeDisplay is separately allocated from the callout_type argument string. In some cases the new string will contain an extended form of the callout_type passed in, and that form should be used for subsequent calls, without modification.

Returns:
The display data for the callout type.
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")
Parameters:
calloutTypeThe name of the callout type for which to get the display data.

Returns the display data for a flat pattern object type.

Returns:
The display data for the flat pattern object type.
Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")
Parameters:
objectTypeThe object type for which to return the display data.

Sets the display data for a callout type.


Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
calloutTypeThe name of the callout type for which to set the display data.
displayDataThe display data for the callout type.

Sets the display data for a flat pattern object type.


Created in NX5.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
objectTypeThe object type for which to get the display data.
displayDataThe display data for the flat pattern object type.

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