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

Represents a NormalCutout feature builder. More...

Inheritance diagram for NXOpen::Features::SheetMetal::NormalCutoutBuilder:
NXOpen::Features::SheetMetal::SheetmetalBaseBuilder NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CutTypeOptions { CutTypeOptionsThicknessCut, CutTypeOptionsMidPlaneCut, CutTypeOptionsNearestFaceCut }
 This enum represents the cut type for the normal cutout. More...
 
enum  DepthSideOptions { DepthSideOptionsSectionNormalSide, DepthSideOptionsSectionReverseNormalSide, DepthSideOptionsSymmetric }
 This enum represents the depth direction for the normal cutout. More...
 
enum  DepthTypeOptions { DepthTypeOptionsFinite, DepthTypeOptionsFromTo, DepthTypeOptionsThroughNext, DepthTypeOptionsThroughAll }
 This enum represents the depth type for the normal cutout. More...
 
enum  SectionSideOptions { SectionSideOptionsLeft, SectionSideOptionsRight }
 This enum represents the side of the section that the normal cutout removes material. More...
 
enum  TypeOptions { TypeOptionsSketchType, TypeOptionsNonPlanarCurveType }
 Represents the type of the normal cutout - sketch type OR 3D-curve type. More...
 

Public Member Functions

NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions CutType ()
 Returns the cut type for the normal cutout. More...
 
NXOpen::ExpressionDepth ()
 Returns the depth of the cutout. More...
 
NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions DepthSide ()
 Returns the depth side for the normal cutout. More...
 
NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions DepthType ()
 Returns the depth type for the normal cutout. More...
 
NXOpen::ISurfaceFrom ()
 Returns the face or datum plane from which the cutout begins. More...
 
NXOpen::SectionSection ()
 Returns the section used by the normal cutout. More...
 
NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions SectionSide ()
 Returns the side of the section that the normal cutout removes material. More...
 
void SetCutType (NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions cutType)
 Sets the cut type for the normal cutout. More...
 
void SetDepth (const NXString &depth)
 
More...
 
void SetDepth (const char *depth)
 
More...
 
void SetDepthSide (NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions depthSide)
 Sets the depth side for the normal cutout. More...
 
void SetDepthType (NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions type)
 Sets the depth type for the normal cutout. More...
 
void SetFrom (NXOpen::ISurface *ffrom)
 Sets the face or datum plane from which the cutout begins. More...
 
void SetSection (NXOpen::Section *section)
 Sets the section used by the normal cutout. More...
 
void SetSectionSide (NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions sectionSide)
 Sets the side of the section that the normal cutout removes material. More...
 
void SetSketch (NXOpen::Features::SketchFeature *sketch)
 Sets the internal sketch used by the normal cutout, if it exists. More...
 
void SetTargetBody (NXOpen::Body *targetBody)
 Sets the target body on which the normal cutout is created. More...
 
void SetTo (NXOpen::ISurface *to)
 Sets the face or datum plane at which the cutout ends. More...
 
void SetType (NXOpen::Features::SheetMetal::NormalCutoutBuilder::TypeOptions type)
 Sets the type for the normal cutout. More...
 
NXOpen::Features::SketchFeatureSketch ()
 Returns the internal sketch used by the normal cutout, if it exists. More...
 
NXOpen::BodyTargetBody ()
 Returns the target body on which the normal cutout is created. More...
 
NXOpen::ISurfaceTo ()
 Returns the face or datum plane at which the cutout ends. More...
 
NXOpen::Features::SheetMetal::NormalCutoutBuilder::TypeOptions Type ()
 Returns the type for the normal cutout. More...
 
int ValidateBuilderData ()
 Verify that the builder data is valid for creating a normal cutout. More...
 
- Public Member Functions inherited from NXOpen::Features::SheetMetal::SheetmetalBaseBuilder
NXOpen::Features::SheetMetal::ApplicationContext GetApplicationContext ()
 Get the application context. More...
 
void SetApplicationContext (NXOpen::Features::SheetMetal::ApplicationContext appContext)
 Set the application context. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.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

Represents a NormalCutout feature builder.


To create a new instance of this class, use NXOpen::Features::SheetMetal::SheetmetalManager::CreateNormalCutoutFeatureBuilder

Created in NX4.0.0.

Member Enumeration Documentation

This enum represents the cut type for the normal cutout.

Enumerator
CutTypeOptionsThicknessCut 

thickness cut

CutTypeOptionsMidPlaneCut 

mid plane cut

CutTypeOptionsNearestFaceCut 

nearest face cut

This enum represents the depth direction for the normal cutout.

Not used if the normal cutout is from-to.

Enumerator
DepthSideOptionsSectionNormalSide 

Material removed on the side of the section normal.

DepthSideOptionsSectionReverseNormalSide 

Material removed on the side opposite to that of the section normal.

DepthSideOptionsSymmetric 

Material removed in both directions equally.

Only applies when the depth type is NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFinite .

This enum represents the depth type for the normal cutout.

Enumerator
DepthTypeOptionsFinite 

Finite.

DepthTypeOptionsFromTo 

From To.

DepthTypeOptionsThroughNext 

Though Next.

DepthTypeOptionsThroughAll 

Through All.

This enum represents the side of the section that the normal cutout removes material.

The "left" option represents the side to the left of a person who is walking along the section in the direction of its curves when the section normal is pointing up. The "right" option represents the person's right hand side. This interpretation is the same regardless of whether the section is open or closed. The "right" side at any point along the section can also be represented by the vector resulting from the cross product of the curve tangent (of the section curve at that point) and the section normal. The "left" side is the opposite.

Enumerator
SectionSideOptionsLeft 

Side pointed to by the inverse of the tangent cross normal vector.

SectionSideOptionsRight 

Side pointed to by the tangent cross normal vector.

Represents the type of the normal cutout - sketch type OR 3D-curve type.

Enumerator
TypeOptionsSketchType 

Sketch type normal cutout.

TypeOptionsNonPlanarCurveType 

3D curves type normal cutout

Member Function Documentation

NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutType ( )

Returns the cut type for the normal cutout.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Expression* NXOpen::Features::SheetMetal::NormalCutoutBuilder::Depth ( )

Returns the depth of the cutout.

Only applies when the depth type is NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFinite .
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSide ( )

Returns the depth side for the normal cutout.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthType ( )

Returns the depth type for the normal cutout.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::ISurface* NXOpen::Features::SheetMetal::NormalCutoutBuilder::From ( )

Returns the face or datum plane from which the cutout begins.

This is only applicable if the depth type is NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFromTo
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Section* NXOpen::Features::SheetMetal::NormalCutoutBuilder::Section ( )

Returns the section used by the normal cutout.

It can be open or closed.
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSide ( )

Returns the side of the section that the normal cutout removes material.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetCutType ( NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions  cutType)

Sets the cut type for the normal cutout.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
cutTypecut type
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetDepth ( const NXString depth)


Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Expression::SetRightHandSide on the NXOpen::Expression object returned from NXOpen::Features::SheetMetal::NormalCutoutBuilder::Depth instead.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
depthdepth
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetDepth ( const char *  depth)


Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Expression::SetRightHandSide on the NXOpen::Expression object returned from NXOpen::Features::SheetMetal::NormalCutoutBuilder::Depth instead.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
depthdepth
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetDepthSide ( NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions  depthSide)

Sets the depth side for the normal cutout.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
depthSidedepth side
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetDepthType ( NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions  type)

Sets the depth type for the normal cutout.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
typetype
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetFrom ( NXOpen::ISurface ffrom)

Sets the face or datum plane from which the cutout begins.

This is only applicable if the depth type is NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFromTo
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
ffromFrom face or datum plane
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetSection ( NXOpen::Section section)

Sets the section used by the normal cutout.

It can be open or closed.
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
sectionsection
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetSectionSide ( NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions  sectionSide)

Sets the side of the section that the normal cutout removes material.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
sectionSidesection side
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetSketch ( NXOpen::Features::SketchFeature sketch)

Sets the internal sketch used by the normal cutout, if it exists.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
sketchsketch
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetTargetBody ( NXOpen::Body targetBody)

Sets the target body on which the normal cutout is created.


Created in NX10.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
targetBodyA sheetmetal body on which normal cutout is to be created.
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetTo ( NXOpen::ISurface to)

Sets the face or datum plane at which the cutout ends.

This is only applicable if the depth type is NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFromTo
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
toTo face or datum plane
void NXOpen::Features::SheetMetal::NormalCutoutBuilder::SetType ( NXOpen::Features::SheetMetal::NormalCutoutBuilder::TypeOptions  type)

Sets the type for the normal cutout.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::TypeOptions .


Created in NX6.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
typetype
NXOpen::Features::SketchFeature* NXOpen::Features::SheetMetal::NormalCutoutBuilder::Sketch ( )

Returns the internal sketch used by the normal cutout, if it exists.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Body* NXOpen::Features::SheetMetal::NormalCutoutBuilder::TargetBody ( )

Returns the target body on which the normal cutout is created.


Created in NX10.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::ISurface* NXOpen::Features::SheetMetal::NormalCutoutBuilder::To ( )

Returns the face or datum plane at which the cutout ends.

This is only applicable if the depth type is NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFromTo
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

NXOpen::Features::SheetMetal::NormalCutoutBuilder::TypeOptions NXOpen::Features::SheetMetal::NormalCutoutBuilder::Type ( )

Returns the type for the normal cutout.

The options are in NXOpen::Features::SheetMetal::NormalCutoutBuilder::TypeOptions .


Created in NX6.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

int NXOpen::Features::SheetMetal::NormalCutoutBuilder::ValidateBuilderData ( )

Verify that the builder data is valid for creating a normal cutout.


If the builder data is valid, a value of 0 is returned.

Returns
data validity flag (zero is valid, non-zero is invalid).
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

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