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

Represents the trim body feature builder. More...

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

Public Types

enum  DirectionType { DirectionTypePositiveNormal = 1, DirectionTypeNegativeNormal = -1, DirectionTypeInvalid }
 Represents the trim direction. More...
 

Public Member Functions

void AddTarget (NXOpen::Body *target)
 Adds a target body during create. More...
 
std::vector< NXOpen::Body * > GetTargets ()
 Returns the target bodies of the trim body operation. More...
 
void RemoveTarget (NXOpen::Body *target)
 Removes a target body is removed from trim body in create. More...
 
void Reverse ()
 Reverse the trim direction of trim body feature. More...
 
void SetTargets (const std::vector< NXOpen::Body * > &target)
 Sets the targets for a trim body opearation. More...
 
void SetTool (NXOpen::NXObject *tool)
 Sets the tool of the trim body feature. More...
 
void SetTrimDirection (NXOpen::Features::TrimBodyBuilder::DirectionType direction)
 Sets the trim direction of the trim body feature
Created in NX4.0.0. More...
 
NXOpen::NXObjectTool ()
 Returns the tool of the trim body feature. More...
 
NXOpen::Features::TrimBodyBuilder::DirectionType TrimDirection ()
 Returns the trim direction of the trim body feature
Created in NX4.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 the trim body feature builder.

This class is to be used only for editing pre-NX7.5.0 trim body features. Use NXOpen::Features::TrimBody2Builder to create and edit trim body features.
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateTrimBodyBuilder

Created in NX4.0.0.

Member Enumeration Documentation

Represents the trim direction.

Enumerator
DirectionTypePositiveNormal 

positive normal

DirectionTypeNegativeNormal 

negative normal

DirectionTypeInvalid 

invalid

Member Function Documentation

void NXOpen::Features::TrimBodyBuilder::AddTarget ( NXOpen::Body target)

Adds a target body during create.

A new target will be added to the trim body operation. During edit, an exception will be thrown as the target can not be modified during edit.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
targetBody to add
std::vector<NXOpen::Body *> NXOpen::Features::TrimBodyBuilder::GetTargets ( )

Returns the target bodies of the trim body operation.

Returns
Target bodies
Created in NX4.0.0.

License requirements : None
void NXOpen::Features::TrimBodyBuilder::RemoveTarget ( NXOpen::Body target)

Removes a target body is removed from trim body in create.

During edit, an exception will be thrown as target body can not be changed during edit.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
targetBody to remove
void NXOpen::Features::TrimBodyBuilder::Reverse ( )

Reverse the trim direction of trim body feature.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::TrimBodyBuilder::SetTargets ( const std::vector< NXOpen::Body * > &  target)

Sets the targets for a trim body opearation.

Any existing targets will be erased. For create multiple target bodies can be set. This method will throw an exception during edit operation as the bodies can not be changed at that point.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
targettarget bodies
void NXOpen::Features::TrimBodyBuilder::SetTool ( NXOpen::NXObject tool)

Sets the tool of the trim body feature.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
toolSet trim body tool
void NXOpen::Features::TrimBodyBuilder::SetTrimDirection ( NXOpen::Features::TrimBodyBuilder::DirectionType  direction)

Sets the trim direction of the trim body feature
Created in NX4.0.0.



License requirements : None

Parameters
directionSet trim direction
NXOpen::NXObject* NXOpen::Features::TrimBodyBuilder::Tool ( )

Returns the tool of the trim body feature.


Created in NX4.0.0.

License requirements : None

NXOpen::Features::TrimBodyBuilder::DirectionType NXOpen::Features::TrimBodyBuilder::TrimDirection ( )

Returns the trim direction of the trim body feature
Created in NX4.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.