NX Open C++ Reference Guide
Public Member Functions
NXOpen::SketchOffsetBuilder Class Reference

Represents a SketchOffsetBuilder
To create a new instance of this class, use SketchCollection::CreateSketchOffsetBuilder
Default values. More...

Inheritance diagram for NXOpen::SketchOffsetBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Member Functions

void BreakChain (NXOpen::NXObject *object1, NXOpen::NXObject *object2, const NXOpen::Point3d &helpPt)
 This function breaks the base chain and all the associated offsets at a given location
Created in NX5.0.0.
NXOpen::SketchOffset::CapType CapType ()
 Returns the type of the cap needed at the corners
Created in NX5.0.0.
bool ConvertToReference ()
 Returns the flag to indicate if the input curves needs to converted to reference
Created in NX5.0.0.
bool CreateDimension ()
 Returns the flag to create offset with a dimension or a dimensionless offset
Created in NX5.0.0.
NXOpen::SectionCreateSection ()
 The function creates a new empty section object and adds it to the builder.
int Degree ()
 Returns the degree for approximating offset spline
Created in NX5.0.0.
NXOpen::ExpressionDistance ()
 Returns the offset distance expression
Created in NX5.0.0.
std::vector< NXOpen::NXObject * > GetOutputCurvesOfOffset ()
 This function gets all output curves of an offset.
std::vector< NXOpen::Section * > GetSections ()
 This function gets all sections of an offset during create/edit.
bool IsSymmetric ()
 Returns the flag to indicate if the offset needs to be symmetric or not
Created in NX5.0.0.
void MergeChains (NXOpen::NXObject *object1, NXOpen::NXObject *object2, const NXOpen::Point3d &helpPt)
 This function merges the two chains.
int NumberOfCopies ()
 Returns the number of offset copies
Created in NX5.0.0.
void RemoveSection (NXOpen::Section *section)
 The function removes the given section from the builder
Created in NX5.0.0.
void ReverseOffsetDirectionOfChain (NXOpen::NXObject *objectInChain)
 This function reverses the offset direction of the chain containing the input geometry
Created in NX5.0.0.
void SetCapType (NXOpen::SketchOffset::CapType capType)
 Sets the type of the cap needed at the corners
Created in NX5.0.0.
void SetConvertToReference (bool reference)
 Sets the flag to indicate if the input curves needs to converted to reference
Created in NX5.0.0.
void SetCreateDimension (bool createDim)
 Sets the flag to create offset with a dimension or a dimensionless offset
Created in NX5.0.0.
void SetDegree (int degree)
 Sets the degree for approximating offset spline
Created in NX5.0.0.
void SetEndConstraint (NXOpen::NXObject *objectInChain, int inx, bool isStartEnd, bool constraint)
 This function removes end constraint from the given offset
Created in NX5.0.0.
void SetNumberOfCopies (int copies)
 Sets the number of offset copies
Created in NX5.0.0.
void SetSymmetric (bool symmetric)
 Sets the flag to indicate if the offset needs to be symmetric or not
Created in NX5.0.0.
void SetTolerance (double tolerance)
 Sets the tolerance for approximating offset spline
Created in NX5.0.0.
double Tolerance ()
 Returns the tolerance for approximating offset spline
Created in NX5.0.0.
void UpdateLoopsAndCopies ()
 This function will update the offset after curves are selected.

Detailed Description

Represents a SketchOffsetBuilder
To create a new instance of this class, use SketchCollection::CreateSketchOffsetBuilder
Default values.

Property Value

CapType

Extension

ConvertToReference

False

CreateDimension

True

Degree

3

Distance.Value

5.0 (millimeters part), 2.0 (inches part)

IsSymmetric

False

NumberOfCopies

1


Created in NX5.0.0.


Member Function Documentation

void NXOpen::SketchOffsetBuilder::BreakChain ( NXOpen::NXObject object1,
NXOpen::NXObject object2,
const NXOpen::Point3d helpPt 
)

This function breaks the base chain and all the associated offsets at a given location
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
object1An object in chain to break
object2Adjacent object to the previous one
helpPtHelp point for multiple intersections

Returns the type of the cap needed at the corners
Created in NX5.0.0.



License requirements : None

Returns the flag to indicate if the input curves needs to converted to reference
Created in NX5.0.0.



License requirements : None

Returns the flag to create offset with a dimension or a dimensionless offset
Created in NX5.0.0.



License requirements : None

The function creates a new empty section object and adds it to the builder.

Returns:
New section object
Created in NX5.0.0.

License requirements : None

Returns the degree for approximating offset spline
Created in NX5.0.0.



License requirements : None

Returns the offset distance expression
Created in NX5.0.0.



License requirements : None

This function gets all output curves of an offset.

Returns:
All the curves associated with constraint
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

This function gets all sections of an offset during create/edit.

Returns:
All the sections associated with the builder
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Returns the flag to indicate if the offset needs to be symmetric or not
Created in NX5.0.0.



License requirements : None

void NXOpen::SketchOffsetBuilder::MergeChains ( NXOpen::NXObject object1,
NXOpen::NXObject object2,
const NXOpen::Point3d helpPt 
)

This function merges the two chains.

The last geom of first chain and first geom of next chain are taken as input.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
object1Last geom of first chain
object2First geom of next chain
helpPtHelp point for multiple intersections

Returns the number of offset copies
Created in NX5.0.0.



License requirements : None

The function removes the given section from the builder
Created in NX5.0.0.



License requirements : None

Parameters:
sectionSection obj to remove

This function reverses the offset direction of the chain containing the input geometry
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
objectInChainAn object in chain to reverse

Sets the type of the cap needed at the corners
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
capTypecaptype

Sets the flag to indicate if the input curves needs to converted to reference
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
referencereference

Sets the flag to create offset with a dimension or a dimensionless offset
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
createDimcreatedim

Sets the degree for approximating offset spline
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
degreedegree
void NXOpen::SketchOffsetBuilder::SetEndConstraint ( NXOpen::NXObject objectInChain,
int  inx,
bool  isStartEnd,
bool  constraint 
)

This function removes end constraint from the given offset
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
objectInChainAn object in the base chain
inxIndex of the constraint - starts from 0
isStartEndTRUE, if we want to remove the start end con
constraintTRUE to add the con, false to remove

Sets the number of offset copies
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
copiescopies

Sets the flag to indicate if the offset needs to be symmetric or not
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
symmetricsymmetric
void NXOpen::SketchOffsetBuilder::SetTolerance ( double  tolerance)

Sets the tolerance for approximating offset spline
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
tolerancetolerance

Returns the tolerance for approximating offset spline
Created in NX5.0.0.



License requirements : None

This function will update the offset after curves are selected.

If the input section is updated to add/remove curves, this function must be called to update the offset constraint. This function will keep the offset constraint synchronised with the edits done to input section.
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")


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