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

Represents a NXOpen::Features::ExtendSheet builder
To create a new instance of this class, use NXOpen::Features::TrimFeatureCollection::CreateExtendSheetBuilder
Default values. More...

Inheritance diagram for NXOpen::Features::ExtendSheetBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BodyOutput { BodyOutputExtendOriginalSheet, BodyOutputExtendasNewFace, BodyOutputExtendasNewSheet }
 Creates extension as an existing or a new entity. More...
 
enum  Limit { LimitOffset, LimitUntilSelected }
 Determines the Limit type for extension. More...
 
enum  SideEdgeShape { SideEdgeShapeAutomatic, SideEdgeShapeTangent, SideEdgeShapeOrthogonal }
 Determines the path of the extension. More...
 
enum  SurfaceShape { SurfaceShapeNaturalCurvature, SurfaceShapeNaturalTangent, SurfaceShapeMirrored }
 Determines the surface type of the extension. More...
 

Public Member Functions

NXOpen::Features::ExtendSheetBuilder::BodyOutput BodyOutputOption ()
 Returns the option to control whether the shape is extended as the original sheet, as a new face, or as a new sheet
Created in NX9.0.0. More...
 
bool CopyOriginal ()
 Returns the copy original option determines if the original body is modified or a copy of the original is made
Created in NX9.0.0. More...
 
double DistanceTolerance ()
 Returns the distance tolerance
Created in NX9.0.0. More...
 
NXOpen::Features::ExtendSheetBuilder::Limit LimitMethod ()
 Returns the option to control limit by distance or until selected objects
Created in NX9.0.0. More...
 
NXOpen::ScCollectorLimitTools ()
 Returns the limiting tool face or plane to extend to
Created in NX9.0.0. More...
 
NXOpen::ExpressionOffset ()
 Returns the offset distance to extend
Created in NX9.0.0. More...
 
void ReverseExtensionSide ()
 Option to reverse the extension side of the edge
Created in NX11.0.0. More...
 
void SetBodyOutputOption (NXOpen::Features::ExtendSheetBuilder::BodyOutput bodyOutputOption)
 Sets the option to control whether the shape is extended as the original sheet, as a new face, or as a new sheet
Created in NX9.0.0. More...
 
void SetCopyOriginal (bool copyOriginal)
 Sets the copy original option determines if the original body is modified or a copy of the original is made
Created in NX9.0.0. More...
 
void SetDistanceTolerance (double tolerance)
 Sets the distance tolerance
Created in NX9.0.0. More...
 
void SetLimitMethod (NXOpen::Features::ExtendSheetBuilder::Limit limitMethod)
 Sets the option to control limit by distance or until selected objects
Created in NX9.0.0. More...
 
void SetSideEdgeShapeOption (NXOpen::Features::ExtendSheetBuilder::SideEdgeShape sideEdgeShapeOption)
 Sets the direction by which the edge is extended
Created in NX9.0.0. More...
 
void SetSurfaceShapeOption (NXOpen::Features::ExtendSheetBuilder::SurfaceShape surfaceShapeOption)
 Sets the method by which the surface is extended which defines the shape
Created in NX9.0.0. More...
 
NXOpen::Features::ExtendSheetBuilder::SideEdgeShape SideEdgeShapeOption ()
 Returns the direction by which the edge is extended
Created in NX9.0.0. More...
 
NXOpen::Features::ExtendSheetBuilder::SurfaceShape SurfaceShapeOption ()
 Returns the method by which the surface is extended which defines the shape
Created in NX9.0.0. More...
 
NXOpen::ScCollectorTargetBoundaryEdges ()
 Returns the input edges to extend
Created in NX9.0.0. 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 NXOpen::Features::ExtendSheet builder
To create a new instance of this class, use NXOpen::Features::TrimFeatureCollection::CreateExtendSheetBuilder
Default values.

Property Value

BodyOutputOption

ExtendOriginalSheet

CopyOriginal

false

LimitMethod

Offset

Offset.Value

5 (millimeters part), 0.2 (inches part)

SideEdgeShapeOption

Automatic

SurfaceShapeOption

NaturalCurvature


Created in NX9.0.0.

Member Enumeration Documentation

Creates extension as an existing or a new entity.

Enumerator
BodyOutputExtendOriginalSheet 

extend original sheet

BodyOutputExtendasNewFace 

extendas new face

BodyOutputExtendasNewSheet 

extendas new sheet

Determines the Limit type for extension.

Enumerator
LimitOffset 

Limit by offset distance.

LimitUntilSelected 

Limit by selected face/plane.

Determines the path of the extension.

Enumerator
SideEdgeShapeAutomatic 

automatic

SideEdgeShapeTangent 

tangent

SideEdgeShapeOrthogonal 

orthogonal

Determines the surface type of the extension.

Enumerator
SurfaceShapeNaturalCurvature 

Extends a B-surface with a small area that is curvature continuous at the boundary, and then tangent beyond that area.

SurfaceShapeNaturalTangent 

Extends a B-surface tangent from the boundary.

SurfaceShapeMirrored 

Extends a B-surface by mirroring the curvature continuous shape of the surface.

Member Function Documentation

NXOpen::Features::ExtendSheetBuilder::BodyOutput NXOpen::Features::ExtendSheetBuilder::BodyOutputOption ( )

Returns the option to control whether the shape is extended as the original sheet, as a new face, or as a new sheet
Created in NX9.0.0.



License requirements : None

bool NXOpen::Features::ExtendSheetBuilder::CopyOriginal ( )

Returns the copy original option determines if the original body is modified or a copy of the original is made
Created in NX9.0.0.



License requirements : None

double NXOpen::Features::ExtendSheetBuilder::DistanceTolerance ( )

Returns the distance tolerance
Created in NX9.0.0.



License requirements : None

NXOpen::Features::ExtendSheetBuilder::Limit NXOpen::Features::ExtendSheetBuilder::LimitMethod ( )

Returns the option to control limit by distance or until selected objects
Created in NX9.0.0.



License requirements : None

NXOpen::ScCollector* NXOpen::Features::ExtendSheetBuilder::LimitTools ( )

Returns the limiting tool face or plane to extend to
Created in NX9.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Features::ExtendSheetBuilder::Offset ( )

Returns the offset distance to extend
Created in NX9.0.0.



License requirements : None

void NXOpen::Features::ExtendSheetBuilder::ReverseExtensionSide ( )

Option to reverse the extension side of the edge
Created in NX11.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::ExtendSheetBuilder::SetBodyOutputOption ( NXOpen::Features::ExtendSheetBuilder::BodyOutput  bodyOutputOption)

Sets the option to control whether the shape is extended as the original sheet, as a new face, or as a new sheet
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
bodyOutputOptionbodyoutputoption
void NXOpen::Features::ExtendSheetBuilder::SetCopyOriginal ( bool  copyOriginal)

Sets the copy original option determines if the original body is modified or a copy of the original is made
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
copyOriginalcopyoriginal
void NXOpen::Features::ExtendSheetBuilder::SetDistanceTolerance ( double  tolerance)

Sets the distance tolerance
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
tolerancetolerance
void NXOpen::Features::ExtendSheetBuilder::SetLimitMethod ( NXOpen::Features::ExtendSheetBuilder::Limit  limitMethod)

Sets the option to control limit by distance or until selected objects
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
limitMethodlimitmethod
void NXOpen::Features::ExtendSheetBuilder::SetSideEdgeShapeOption ( NXOpen::Features::ExtendSheetBuilder::SideEdgeShape  sideEdgeShapeOption)

Sets the direction by which the edge is extended
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
sideEdgeShapeOptionsideedgeshapeoption
void NXOpen::Features::ExtendSheetBuilder::SetSurfaceShapeOption ( NXOpen::Features::ExtendSheetBuilder::SurfaceShape  surfaceShapeOption)

Sets the method by which the surface is extended which defines the shape
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
surfaceShapeOptionsurfaceshapeoption
NXOpen::Features::ExtendSheetBuilder::SideEdgeShape NXOpen::Features::ExtendSheetBuilder::SideEdgeShapeOption ( )

Returns the direction by which the edge is extended
Created in NX9.0.0.



License requirements : None

NXOpen::Features::ExtendSheetBuilder::SurfaceShape NXOpen::Features::ExtendSheetBuilder::SurfaceShapeOption ( )

Returns the method by which the surface is extended which defines the shape
Created in NX9.0.0.



License requirements : None

NXOpen::ScCollector* NXOpen::Features::ExtendSheetBuilder::TargetBoundaryEdges ( )

Returns the input edges to extend
Created in NX9.0.0.



License requirements : None


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