NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::GeometricUtilities::BoundaryDefinitionBuilder Class Reference

Represents a NXOpen::GeometricUtilities::BoundaryDefinitionBuilder . More...

Inheritance diagram for NXOpen::GeometricUtilities::BoundaryDefinitionBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void AppendPoint (const NXOpen::Point3d &point, bool isKeyPoint)
 Appends a point to the boundary definition
Created in NX7.5.0. More...
 
bool Close ()
 Closes the boundary by appending start point at the end of boundary definition. More...
 
void DeleteAll ()
 Deletes all the points in the boundary definition
Created in NX7.5.0. More...
 
void DeleteLastKeyPoint ()
 Deletes last key point and all the points from last key point up to and excluding its previous key point
Created in NX7.5.0. More...
 
NXOpen::ExpressionDepth ()
 Returns the region depth
Created in NX7.5.0. More...
 
std::vector< NXOpen::Point3dGetPoints ()
 Queries all the boundary definition points. More...
 
void SetPlaneNormal (const NXOpen::Vector3d &direction)
 Sets normal of the plane in which boundary is defined
Created in NX7.5.0. More...
 
void Translate (const NXOpen::Vector3d &vector)
 Translates the boundary from its current position using the direction and the magnitude of a vector. 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::GeometricUtilities::BoundaryDefinitionBuilder .

A boundary definition is a collection of ordered points which can be imagined to be connected by a polyline indicating a boundary. Any point in the collection can be marked as a key point. Marking some points as key points helps to delete part of the boundary efficiently. All the points in a boundary definition are co-planar. A depth value can be specified to define a 3D boundary equivalent to an extrusion.
Created in NX7.5.0.

Member Function Documentation

void NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::AppendPoint ( const NXOpen::Point3d point,
bool  isKeyPoint 
)

Appends a point to the boundary definition
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
pointPoint to append
isKeyPointFlag indicating if point is a key point
bool NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::Close ( )

Closes the boundary by appending start point at the end of boundary definition.

Returns

Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")
void NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::DeleteAll ( )

Deletes all the points in the boundary definition
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

void NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::DeleteLastKeyPoint ( )

Deletes last key point and all the points from last key point up to and excluding its previous key point
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::Expression* NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::Depth ( )

Returns the region depth
Created in NX7.5.0.



License requirements : None

std::vector<NXOpen::Point3d> NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::GetPoints ( )

Queries all the boundary definition points.

Returns

Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")
void NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::SetPlaneNormal ( const NXOpen::Vector3d direction)

Sets normal of the plane in which boundary is defined
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
directiondirection
void NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::Translate ( const NXOpen::Vector3d vector)

Translates the boundary from its current position using the direction and the magnitude of a vector.


Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
vectorvector
virtual bool NXOpen::GeometricUtilities::BoundaryDefinitionBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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