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

Represents a Base Centerline Builder for all types of centerlines
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::Annotations::CenterlineBuilder:
NXOpen::Annotations::BaseSymbolBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::BaseCenterline3dBuilder NXOpen::Annotations::BaseCenterMarkBuilder NXOpen::Annotations::Centerline2dBuilder NXOpen::Annotations::CircleCenterlineBuilder NXOpen::Annotations::SymmetricalCenterlineBuilder NXOpen::Annotations::Centerline3dBuilder NXOpen::Annotations::PmiCenterline3dBuilder NXOpen::Annotations::CenterMarkBuilder NXOpen::Annotations::PmiCenterMarkBuilder NXOpen::Annotations::BoltCircleCenterlineBuilder NXOpen::Annotations::CircularCenterlineBuilder

List of all members.

Public Member Functions

void AddEndExtensions (double start, double end)
 Adds extensions only at ends
Created in NX6.0.0.
void AddExtension (int index, double defaultValue)
 Adds extension based on select object index
Created in NX6.0.0.
std::vector< double > GetAllExtensions ()
 Returns all extensions.
std::vector< double > GetAllIndividualExtensions ()
 Returns individual extensions.
std::vector< double > GetEndExtensions ()
 Returns end extensions only.
void RemoveEndExtensions ()
 Removes extensions only at ends
Created in NX6.0.0.
void RemoveExtension (int index)
 Removes extension based on select object index
Created in NX6.0.0.
void ResetAllExtensions (double defaultValue)
 Reset all extensions by the supplied defaultValue
Created in NX6.0.1.
void SetAllIndividualExtensions (const std::vector< double > &extensionValues)
 Sets all individual extensions
Created in NX8.0.1.
void SetEndExtensions (double start, double end)
 Modifies end extensions only
Created in NX6.0.0.
void SetIndividualExtensions (int index, double value1, double value2)
 Modifies extensions based on select object index
Created in NX6.0.0.

Detailed Description

Represents a Base Centerline Builder for all types of centerlines
This is an abstract class, and cannot be instantiated.



Created in NX6.0.0.


Member Function Documentation

void NXOpen::Annotations::CenterlineBuilder::AddEndExtensions ( double  start,
double  end 
)

Adds extensions only at ends
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
startDefault start extension value
endDefault end extension value
void NXOpen::Annotations::CenterlineBuilder::AddExtension ( int  index,
double  defaultValue 
)

Adds extension based on select object index
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
indexIndex of the selected object
defaultValueDefault extension value

Returns all extensions.

If the builder is a Annotations::BoltCircleCenterlineBuilder or Annotations::CircularCenterlineBuilder and Annotations::CircleCenterlineSettingsBuilder::IndividualDistance is false, this will method will return no extensions.

Returns:
Extension values as output
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Returns individual extensions.

This method is applicable only for Annotations::CenterMark and Annotations::CircleCenterline .

If the builder is a Annotations::BoltCircleCenterlineBuilder or Annotations::CircularCenterlineBuilder and Annotations::CircleCenterlineSettingsBuilder::IndividualDistance is false, this will method will return no extensions.

Returns:
Extension values as output
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Returns end extensions only.

The first and the last extension of the centerline.

If the builder is a Annotations::BoltCircleCenterlineBuilder or Annotations::CircularCenterlineBuilder and Annotations::CircleCenterlineSettingsBuilder::IndividualDistance is false, this will method will return no extensions.

Returns:
Extension values as output
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Removes extensions only at ends
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Removes extension based on select object index
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
indexIndex of the selected object

Reset all extensions by the supplied defaultValue
Created in NX6.0.1.



License requirements : drafting ("DRAFTING")

Parameters:
defaultValueNew extension value
void NXOpen::Annotations::CenterlineBuilder::SetAllIndividualExtensions ( const std::vector< double > &  extensionValues)

Sets all individual extensions
Created in NX8.0.1.



License requirements : drafting ("DRAFTING")

Parameters:
extensionValuesExtension values as input
void NXOpen::Annotations::CenterlineBuilder::SetEndExtensions ( double  start,
double  end 
)

Modifies end extensions only
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
startNew extension value at one end
endNew extension value at one end
void NXOpen::Annotations::CenterlineBuilder::SetIndividualExtensions ( int  index,
double  value1,
double  value2 
)

Modifies extensions based on select object index
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
indexIndex of the selected object
value1New extension value at one end
value2New extension value at other end

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