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

Builder for creating 3D Centerline. More...

Inheritance diagram for NXOpen::Annotations::Centerline3dBuilder:
NXOpen::Annotations::BaseCenterline3dBuilder NXOpen::Annotations::CenterlineBuilder NXOpen::Annotations::BaseSymbolBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Offset { OffsetNone, OffsetDistanceMethod, OffsetObjectMethod }
 the valid types of 3D Centerline offset method More...
 

Public Member Functions

bool AlignedCenterlines ()
 Returns the aligned centerlines, applicable only for creation
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectInherit ()
 Returns the inherit object
Created in NX6.0.0. More...
 
double OffsetDistance ()
 Returns the offset distance, it is used only when aligned centerlines toggle is off
Created in NX6.0.0. More...
 
NXOpen::Annotations::Centerline3dBuilder::Offset OffsetMethod ()
 Returns the offset method , it is used only when aligned centerlines toggle is off
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectOffsetObject ()
 Returns the offset object, it is used only when aligned centerlines toggle is off
Created in NX6.0.0. More...
 
void SetAlignedCenterlines (bool alignedCenterlines)
 Sets the aligned centerlines, applicable only for creation
Created in NX6.0.0. More...
 
void SetOffsetDistance (double offsetDistance)
 Sets the offset distance, it is used only when aligned centerlines toggle is off
Created in NX6.0.0. More...
 
void SetOffsetMethod (NXOpen::Annotations::Centerline3dBuilder::Offset offsetMethod)
 Sets the offset method , it is used only when aligned centerlines toggle is off
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Annotations::BaseCenterline3dBuilder
NXOpen::SelectNXObjectListFace ()
 Returns the face
Created in NX6.0.0. More...
 
int ReferenceIndex ()
 Returns the reference index
Created in NX6.0.0. More...
 
void SetReferenceIndex (int referenceIndex)
 Sets the reference index
Created in NX6.0.0. More...
 
NXOpen::Annotations::Centerline3dSettingsBuilderSettings ()
 Returns the settings builder
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Annotations::CenterlineBuilder
void AddEndExtensions (double start, double end)
 Adds extensions only at ends
Created in NX6.0.0. More...
 
void AddExtension (int index, double defaultValue)
 Adds extension based on select object index
Created in NX6.0.0. More...
 
std::vector< double > GetAllExtensions ()
 Returns all extensions. More...
 
std::vector< double > GetAllIndividualExtensions ()
 Returns individual extensions. More...
 
std::vector< double > GetEndExtensions ()
 Returns end extensions only. More...
 
void RemoveEndExtensions ()
 Removes extensions only at ends
Created in NX6.0.0. More...
 
void RemoveExtension (int index)
 Removes extension based on select object index
Created in NX6.0.0. More...
 
void ResetAllExtensions (double defaultValue)
 Reset all extensions by the supplied defaultValue
Created in NX6.0.1. More...
 
void SetAllIndividualExtensions (const std::vector< double > &extensionValues)
 Sets all individual extensions
Created in NX8.0.1. More...
 
void SetEndExtensions (double start, double end)
 Modifies end extensions only
Created in NX6.0.0. More...
 
void SetIndividualExtensions (int index, double value1, double value2)
 Modifies extensions based on select object index
Created in NX6.0.0. More...
 

Detailed Description

Builder for creating 3D Centerline.

It creates or edits 3D Centerlines
To create a new instance of this class, use NXOpen::Annotations::CenterlineCollection::CreateCenterline3dBuilder
Default values.

Property Value

AlignedCenterlines

false

OffsetDistance

0

OffsetMethod

None


Created in NX6.0.0.

Member Enumeration Documentation

the valid types of 3D Centerline offset method

Enumerator
OffsetNone 

No Offset.

OffsetDistanceMethod 

Offset Distance.

OffsetObjectMethod 

Offset Object, applicable only for creation.

Member Function Documentation

bool NXOpen::Annotations::Centerline3dBuilder::AlignedCenterlines ( )

Returns the aligned centerlines, applicable only for creation
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Annotations::Centerline3dBuilder::Inherit ( )

Returns the inherit object
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::Centerline3dBuilder::OffsetDistance ( )

Returns the offset distance, it is used only when aligned centerlines toggle is off
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::Centerline3dBuilder::Offset NXOpen::Annotations::Centerline3dBuilder::OffsetMethod ( )

Returns the offset method , it is used only when aligned centerlines toggle is off
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Annotations::Centerline3dBuilder::OffsetObject ( )

Returns the offset object, it is used only when aligned centerlines toggle is off
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::Centerline3dBuilder::SetAlignedCenterlines ( bool  alignedCenterlines)

Sets the aligned centerlines, applicable only for creation
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
alignedCenterlinesalignedcenterlines
void NXOpen::Annotations::Centerline3dBuilder::SetOffsetDistance ( double  offsetDistance)

Sets the offset distance, it is used only when aligned centerlines toggle is off
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
offsetDistanceoffsetdistance
void NXOpen::Annotations::Centerline3dBuilder::SetOffsetMethod ( NXOpen::Annotations::Centerline3dBuilder::Offset  offsetMethod)

Sets the offset method , it is used only when aligned centerlines toggle is off
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
offsetMethodoffsetmethod

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