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

This class provides ability to define a setback curve on a blend face. More...

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

Public Types

enum  Directions { DirectionsU, DirectionsV, DirectionsPlane }
 Setback direction options. More...
 

Public Member Functions

NXOpen::GeometricUtilities::BlendSetbackBuilder::Directions Direction ()
 Returns the direction type
Created in NX9.0.0. More...
 
NXOpen::ScCollectorFace ()
 Returns the blend face collector. More...
 
NXOpen::PointHandlePoint ()
 Returns the handle point for u/v direction. More...
 
bool IsDirectionFlipped ()
 Returns the flag indicating if the setback curve direction is flipped. More...
 
NXOpen::PlanePlane ()
 Returns the setback plane. More...
 
NXOpen::PointSetbackPoint ()
 Returns the setback point for u/v direction. More...
 
void SetDirection (NXOpen::GeometricUtilities::BlendSetbackBuilder::Directions direction)
 Sets the direction type
Created in NX9.0.0. More...
 
void SetDirectionFlipped (bool flipDirection)
 Sets the flag indicating if the setback curve direction is flipped. More...
 
void SetHandlePoint (NXOpen::Point *handlePoint)
 Sets the handle point for u/v direction. More...
 
void SetPlane (NXOpen::Plane *plane)
 Sets the setback plane. More...
 
void SetSetbackPoint (NXOpen::Point *setbackPoint)
 Sets the setback point for u/v direction. 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

This class provides ability to define a setback curve on a blend face.


To create a new instance of this class, use NXOpen::Part::CreateEmptyBlendSetbackBuilder

Created in NX9.0.0.

Member Enumeration Documentation

Setback direction options.

Enumerator
DirectionsU 

setback curve is an iso-u parameter curve

DirectionsV 

setback curve is an iso-v parameter curve

DirectionsPlane 

setback curve is the intersection curve between a plane and faces

Member Function Documentation

NXOpen::GeometricUtilities::BlendSetbackBuilder::Directions NXOpen::GeometricUtilities::BlendSetbackBuilder::Direction ( )

Returns the direction type
Created in NX9.0.0.



License requirements : None

NXOpen::ScCollector* NXOpen::GeometricUtilities::BlendSetbackBuilder::Face ( )

Returns the blend face collector.

The collector can include faces from different blends.
Created in NX9.0.0.

License requirements : None

NXOpen::Point* NXOpen::GeometricUtilities::BlendSetbackBuilder::HandlePoint ( )

Returns the handle point for u/v direction.

The setback curve will pass through the handle point.
Created in NX9.0.0.

License requirements : None

bool NXOpen::GeometricUtilities::BlendSetbackBuilder::IsDirectionFlipped ( )

Returns the flag indicating if the setback curve direction is flipped.


Created in NX9.0.0.

License requirements : None

NXOpen::Plane* NXOpen::GeometricUtilities::BlendSetbackBuilder::Plane ( )

Returns the setback plane.

The setback curve will be the intersection curve between plane and face collector.
Created in NX9.0.0.

License requirements : None

NXOpen::Point* NXOpen::GeometricUtilities::BlendSetbackBuilder::SetbackPoint ( )

Returns the setback point for u/v direction.

This point is optional. If specified, it will replace the handle point and establish the associativity between the point and the setback curve. Once the handle point is changed through dragging, the associativity will be lost.
Created in NX9.0.0.

License requirements : None

void NXOpen::GeometricUtilities::BlendSetbackBuilder::SetDirection ( NXOpen::GeometricUtilities::BlendSetbackBuilder::Directions  direction)

Sets the direction type
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
directiondirection
void NXOpen::GeometricUtilities::BlendSetbackBuilder::SetDirectionFlipped ( bool  flipDirection)

Sets the flag indicating if the setback curve direction is flipped.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
flipDirectionflipdirection
void NXOpen::GeometricUtilities::BlendSetbackBuilder::SetHandlePoint ( NXOpen::Point handlePoint)

Sets the handle point for u/v direction.

The setback curve will pass through the handle point.
Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
handlePointhandlepoint
void NXOpen::GeometricUtilities::BlendSetbackBuilder::SetPlane ( NXOpen::Plane plane)

Sets the setback plane.

The setback curve will be the intersection curve between plane and face collector.
Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
planeplane
void NXOpen::GeometricUtilities::BlendSetbackBuilder::SetSetbackPoint ( NXOpen::Point setbackPoint)

Sets the setback point for u/v direction.

This point is optional. If specified, it will replace the handle point and establish the associativity between the point and the setback curve. Once the handle point is changed through dragging, the associativity will be lost.
Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
setbackPointsetbackpoint
virtual bool NXOpen::GeometricUtilities::BlendSetbackBuilder::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.