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

Represents a NXOpen::Die::QuickBinderBuilder builder which builds a developable binder sheet body by adding cones, cylinders, or planes to an approximated face. More...

Inheritance diagram for NXOpen::Die::QuickBinderBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  EditTypes {
  EditTypesEdgeExtend, EditTypesEdgeExtendStart, EditTypesEdgeExtendEnd, EditTypesEdgeAngleStart,
  EditTypesEdgeAngleEnd, EditTypesFaceRadius, EditTypesFaceCentralAngle, EditTypesFaceReverseConvexity,
  EditTypesTransform, EditTypesExtendUMinimum, EditTypesExtendUMaximum, EditTypesExtendVMinimum,
  EditTypesExtendVMaximum
}
 The type of edit to be performed on the face. More...
 
enum  Types { TypesPlanar, TypesCylindrical, TypesConical, TypesMonoArc }
 The method used to approximate the product faces. More...
 

Public Member Functions

int AddFace (NXOpen::Die::QuickBinderBuilder::Types type)
 Add a component face to the binder body. More...
 
NXOpen::ExpressionAnchorBaseRadius ()
 Returns the base radius for a conical anchor face. More...
 
NXOpen::ExpressionAnchorRadius ()
 Returns the radius value of a cylidrical anchor face. More...
 
NXOpen::ExpressionAnchorTopRadius ()
 Returns the top radius for a conical anchor face. More...
 
NXOpen::ExpressionBaseRadius ()
 Returns the base radius for a cone. More...
 
NXOpen::ExpressionCentralAngle ()
 Returns the central angle of a cylinder/cone. More...
 
int CreateAnchorFace ()
 Create initial face approximated from the selected faces. More...
 
int EdgeIndexToEdit ()
 Returns the index of the edge to edit. More...
 
void EditFace ()
 Edit the parameters of a face according to the type of edit previously indicated by NXOpen::Die::QuickBinderBuilder::EditType . More...
 
NXOpen::Die::QuickBinderBuilder::EditTypes EditType ()
 Returns the type edit to be performed on the face or edge. More...
 
NXOpen::ExpressionEnd ()
 Returns the end length extension. More...
 
NXOpen::ExpressionEndAngle ()
 Returns the end angle of a planar face. More...
 
NXOpen::ExpressionExtend ()
 Returns the value to extend both sides of a face. More...
 
int FaceIndexToEdit ()
 Returns the index of the face to edit. More...
 
NXOpen::ScCollectorFaces ()
 Returns the product faces used to perform the initial approximation. More...
 
void GetEdgesOfFace (int faceIndex, std::vector< int > &edgeIndex, std::vector< NXOpen::Point3d > &referencePoints)
 Get the edge indexes for a face. More...
 
NXOpen::GeometricUtilities::LimitsLimits ()
 Returns the central angle limits of cylinder/cone. More...
 
NXOpen::Point3d OriginAnchorOrigin ()
 Returns the anchor origin of binder sheet body. More...
 
NXOpen::ExpressionRadius ()
 Returns the radius value of a cylidrical face. More...
 
void RemoveFace ()
 Remove a face from the binder body. More...
 
void SetEdgeIndexToEdit (int index)
 Sets the index of the edge to edit. More...
 
void SetEditType (NXOpen::Die::QuickBinderBuilder::EditTypes type)
 Sets the type edit to be performed on the face or edge. More...
 
void SetFaceIndexToEdit (int index)
 Sets the index of the face to edit. More...
 
void SetOriginAnchorOrigin (const NXOpen::Point3d &origin)
 Sets the anchor origin of binder sheet body. More...
 
void SetReferencePoint (const NXOpen::Point3d &location)
 Set the point used to determine the start and end side of the face. More...
 
void SetTransformMatrix (const NXOpen::Matrix3x3 &matrix)
 Sets the rotation matrix of binder sheet body transformation. More...
 
void SetTransformOrigin (const NXOpen::Point3d &origin)
 Sets the new origin of binder sheet body transformation. More...
 
void SetType (NXOpen::Die::QuickBinderBuilder::Types type)
 Sets the type of initial face created by approximating the faces indicated by NXOpen::Die::QuickBinderBuilder::Faces . More...
 
NXOpen::ExpressionStart ()
 Returns the start length extension. More...
 
NXOpen::ExpressionStartAngle ()
 Returns the start angle of a planar face. More...
 
NXOpen::ExpressionTopRadius ()
 Returns the top radius for a cone. More...
 
NXOpen::Matrix3x3 TransformMatrix ()
 Returns the rotation matrix of binder sheet body transformation. More...
 
NXOpen::Point3d TransformOrigin ()
 Returns the new origin of binder sheet body transformation. More...
 
NXOpen::Die::QuickBinderBuilder::Types Type ()
 Returns the type of initial face created by approximating the faces indicated by NXOpen::Die::QuickBinderBuilder::Faces . More...
 
NXOpen::ExpressionUMaximum ()
 Returns the u maximum extension distance. More...
 
NXOpen::ExpressionUMinimum ()
 Returns the u minimum extension distance. More...
 
NXOpen::ExpressionVMaximum ()
 Returns the v maximum extension distance. More...
 
NXOpen::ExpressionVMinimum ()
 Returns the v minimum extension distance. 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::Die::QuickBinderBuilder builder which builds a developable binder sheet body by adding cones, cylinders, or planes to an approximated face.


To create a new instance of this class, use NXOpen::Die::DieCollection::CreateQuickBinderBuilder

Created in NX7.5.0.

Member Enumeration Documentation

The type of edit to be performed on the face.

Enumerator
EditTypesEdgeExtend 

Extend edge of a face.

EditTypesEdgeExtendStart 

Extend start edge of a planar face.

EditTypesEdgeExtendEnd 

Extend end edge of a planar face.

EditTypesEdgeAngleStart 

Change the angle of the start edge of a planar face.

EditTypesEdgeAngleEnd 

Change the angle of the end edge of a planar face.

EditTypesFaceRadius 

Change the face radius of a conical/cylindrical face.

EditTypesFaceCentralAngle 

Change the central angle of a conical/cylindrical face.

EditTypesFaceReverseConvexity 

Reverse the convexity of a conical/cylindrical face.

EditTypesTransform 

Transform body.

EditTypesExtendUMinimum 

Extend the U Minimum edge of the anchor face.

EditTypesExtendUMaximum 

Extend the U Maximum edge of the anchor face.

EditTypesExtendVMinimum 

Extend the V Minimum edge of the anchor face.

EditTypesExtendVMaximum 

Extend the V Maximum edge of the anchor face.

The method used to approximate the product faces.

Enumerator
TypesPlanar 

planar

TypesCylindrical 

cylindrical

TypesConical 

conical

TypesMonoArc 

mono arc

Member Function Documentation

int NXOpen::Die::QuickBinderBuilder::AddFace ( NXOpen::Die::QuickBinderBuilder::Types  type)

Add a component face to the binder body.

Returns
index of component face created
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")
Parameters
typetype of face to add
NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::AnchorBaseRadius ( )

Returns the base radius for a conical anchor face.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::AnchorRadius ( )

Returns the radius value of a cylidrical anchor face.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::AnchorTopRadius ( )

Returns the top radius for a conical anchor face.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::BaseRadius ( )

Returns the base radius for a cone.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::CentralAngle ( )

Returns the central angle of a cylinder/cone.


Created in NX7.5.0.

License requirements : None

int NXOpen::Die::QuickBinderBuilder::CreateAnchorFace ( )

Create initial face approximated from the selected faces.

Returns
index of anchor face created
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")
int NXOpen::Die::QuickBinderBuilder::EdgeIndexToEdit ( )

Returns the index of the edge to edit.


Created in NX7.5.0.

License requirements : None

void NXOpen::Die::QuickBinderBuilder::EditFace ( )

Edit the parameters of a face according to the type of edit previously indicated by NXOpen::Die::QuickBinderBuilder::EditType .


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

NXOpen::Die::QuickBinderBuilder::EditTypes NXOpen::Die::QuickBinderBuilder::EditType ( )

Returns the type edit to be performed on the face or edge.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::End ( )

Returns the end length extension.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::EndAngle ( )

Returns the end angle of a planar face.

This angle rotates the side edge around the face normal with the rotation point being one of the endpoints of the edge that is attached to the previous face.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::Extend ( )

Returns the value to extend both sides of a face.


Created in NX7.5.0.

License requirements : None

int NXOpen::Die::QuickBinderBuilder::FaceIndexToEdit ( )

Returns the index of the face to edit.


Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Die::QuickBinderBuilder::Faces ( )

Returns the product faces used to perform the initial approximation.


Created in NX7.5.0.

License requirements : None

void NXOpen::Die::QuickBinderBuilder::GetEdgesOfFace ( int  faceIndex,
std::vector< int > &  edgeIndex,
std::vector< NXOpen::Point3d > &  referencePoints 
)

Get the edge indexes for a face.

Also returns corresponding points for each edge to be used as input to NXOpen::Die::QuickBinderBuilder::SetReferencePoint .


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
faceIndexface index
edgeIndexedge indexes
referencePointsreference points corresponding to each edge
NXOpen::GeometricUtilities::Limits* NXOpen::Die::QuickBinderBuilder::Limits ( )

Returns the central angle limits of cylinder/cone.


Created in NX7.5.0.

License requirements : None

NXOpen::Point3d NXOpen::Die::QuickBinderBuilder::OriginAnchorOrigin ( )

Returns the anchor origin of binder sheet body.


Created in NX8.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::Radius ( )

Returns the radius value of a cylidrical face.


Created in NX7.5.0.

License requirements : None

void NXOpen::Die::QuickBinderBuilder::RemoveFace ( )

Remove a face from the binder body.

Face to remove is indicated by NXOpen::Die::QuickBinderBuilder::FaceIndexToEdit .


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

void NXOpen::Die::QuickBinderBuilder::SetEdgeIndexToEdit ( int  index)

Sets the index of the edge to edit.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
indexindex
void NXOpen::Die::QuickBinderBuilder::SetEditType ( NXOpen::Die::QuickBinderBuilder::EditTypes  type)

Sets the type edit to be performed on the face or edge.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
typetype
void NXOpen::Die::QuickBinderBuilder::SetFaceIndexToEdit ( int  index)

Sets the index of the face to edit.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
indexindex
void NXOpen::Die::QuickBinderBuilder::SetOriginAnchorOrigin ( const NXOpen::Point3d origin)

Sets the anchor origin of binder sheet body.


Created in NX8.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
originorigin
void NXOpen::Die::QuickBinderBuilder::SetReferencePoint ( const NXOpen::Point3d location)

Set the point used to determine the start and end side of the face.

Also used to determine which end of the conic to edit.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
locationReference Point in absolute coordinates
void NXOpen::Die::QuickBinderBuilder::SetTransformMatrix ( const NXOpen::Matrix3x3 matrix)

Sets the rotation matrix of binder sheet body transformation.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
matrixmatrix
void NXOpen::Die::QuickBinderBuilder::SetTransformOrigin ( const NXOpen::Point3d origin)

Sets the new origin of binder sheet body transformation.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
originorigin
void NXOpen::Die::QuickBinderBuilder::SetType ( NXOpen::Die::QuickBinderBuilder::Types  type)

Sets the type of initial face created by approximating the faces indicated by NXOpen::Die::QuickBinderBuilder::Faces .


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
typetype
NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::Start ( )

Returns the start length extension.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::StartAngle ( )

Returns the start angle of a planar face.

This angle rotates the side edge around the face normal with the rotation point being one of the endpoints of the edge that is attached to the previous face.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::TopRadius ( )

Returns the top radius for a cone.


Created in NX7.5.0.

License requirements : None

NXOpen::Matrix3x3 NXOpen::Die::QuickBinderBuilder::TransformMatrix ( )

Returns the rotation matrix of binder sheet body transformation.


Created in NX7.5.0.

License requirements : None

NXOpen::Point3d NXOpen::Die::QuickBinderBuilder::TransformOrigin ( )

Returns the new origin of binder sheet body transformation.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::QuickBinderBuilder::Types NXOpen::Die::QuickBinderBuilder::Type ( )

Returns the type of initial face created by approximating the faces indicated by NXOpen::Die::QuickBinderBuilder::Faces .


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::UMaximum ( )

Returns the u maximum extension distance.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::UMinimum ( )

Returns the u minimum extension distance.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::VMaximum ( )

Returns the v maximum extension distance.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::QuickBinderBuilder::VMinimum ( )

Returns the v minimum extension distance.


Created in NX7.5.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.