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

Builder for creating 2D Centerline. More...

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

Public Types

enum  Offset { OffsetNone, OffsetDistanceMethod, OffsetObjectMethod }
 the valid types of 2D Centerline offset method More...
 
enum  Types { TypesFromCurves, TypesByPoints }
 the valid types of 2D Centerline, applicable only for creation More...
 

Public Member Functions

NXOpen::SelectNXObjectInherit ()
 Returns the inherit object
Created in NX6.0.0. More...
 
double OffsetDistance ()
 Returns the offset distance for centerline by points
Created in NX6.0.0. More...
 
NXOpen::Annotations::Centerline2dBuilder::Offset OffsetMethod ()
 Returns the offset method for centerline by points
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectOffsetObject ()
 Returns the offset object for centerline by points
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectPoint1 ()
 Returns the point 1 of 2D Centerline for centerline by points
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectPoint2 ()
 Returns the point 2 of 2D Centerline for centerline by points
Created in NX6.0.0. More...
 
void SetOffsetDistance (double offsetDistance)
 Sets the offset distance for centerline by points
Created in NX6.0.0. More...
 
void SetOffsetMethod (NXOpen::Annotations::Centerline2dBuilder::Offset offsetMethod)
 Sets the offset method for centerline by points
Created in NX6.0.0. More...
 
NXOpen::Annotations::Centerline2dSettingsBuilderSettings ()
 Returns the settings builder
Created in NX6.0.0. More...
 
void SetType (NXOpen::Annotations::Centerline2dBuilder::Types type)
 Sets the type
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectSide1 ()
 Returns the side 1 of 2D Centerline for centerline from curves
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectSide2 ()
 Returns the side 2 of 2D Centerline for centerline from curves
Created in NX6.0.0. More...
 
NXOpen::Annotations::Centerline2dBuilder::Types Type ()
 Returns the type
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 2D Centerline.

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

Property Value

OffsetDistance

0

OffsetMethod

None

Settings.Extension

6.35 (millimeters part), 0.25 (inches part)

Settings.Gap

1.5875 (millimeters part), 0.0625 (inches part)

Settings.IndividualDistance

0

Settings.Size

3.175 (millimeters part), 0.125 (inches part)

Settings.Width

Thin

Type

FromCurves


Created in NX6.0.0.

Member Enumeration Documentation

the valid types of 2D Centerline offset method

Enumerator
OffsetNone 

no offset

OffsetDistanceMethod 

offset distance method

OffsetObjectMethod 

offset object method

the valid types of 2D Centerline, applicable only for creation

Enumerator
TypesFromCurves 

centerline from curves

TypesByPoints 

centerline by points

Member Function Documentation

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

Returns the inherit object
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::Centerline2dBuilder::OffsetDistance ( )

Returns the offset distance for centerline by points
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::Centerline2dBuilder::Offset NXOpen::Annotations::Centerline2dBuilder::OffsetMethod ( )

Returns the offset method for centerline by points
Created in NX6.0.0.



License requirements : None

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

Returns the offset object for centerline by points
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Annotations::Centerline2dBuilder::Point1 ( )

Returns the point 1 of 2D Centerline for centerline by points
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Annotations::Centerline2dBuilder::Point2 ( )

Returns the point 2 of 2D Centerline for centerline by points
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::Centerline2dBuilder::SetOffsetDistance ( double  offsetDistance)

Sets the offset distance for centerline by points
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

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

Sets the offset method for centerline by points
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
offsetMethodoffsetmethod
NXOpen::Annotations::Centerline2dSettingsBuilder* NXOpen::Annotations::Centerline2dBuilder::Settings ( )

Returns the settings builder
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

void NXOpen::Annotations::Centerline2dBuilder::SetType ( NXOpen::Annotations::Centerline2dBuilder::Types  type)

Sets the type
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
typetype
NXOpen::SelectNXObject* NXOpen::Annotations::Centerline2dBuilder::Side1 ( )

Returns the side 1 of 2D Centerline for centerline from curves
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Annotations::Centerline2dBuilder::Side2 ( )

Returns the side 2 of 2D Centerline for centerline from curves
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::Centerline2dBuilder::Types NXOpen::Annotations::Centerline2dBuilder::Type ( )

Returns the type
Created in NX6.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.