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

Represents a CircleCenterline Builder
This is an abstract class. More...

Inheritance diagram for NXOpen::Annotations::CircleCenterlineBuilder:
NXOpen::Annotations::CenterlineBuilder NXOpen::Annotations::BaseSymbolBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::BaseBoltCircleCenterlineBuilder NXOpen::Annotations::CircularCenterlineBuilder NXOpen::Annotations::BoltCircleCenterlineBuilder NXOpen::Annotations::PmiBoltCircleCenterlineBuilder

Public Types

enum  Types { TypesThrough3Points, TypesCenterpoint }
 the valid enumeration used for the creation types, applicable only while creation Once created type centerpoint will be set for all bolt circle/circular centerline More...
 

Public Member Functions

bool FullCircle ()
 Returns the method which returns full or partial circle flag
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectInherit ()
 Returns the inherit object
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectListLocations ()
 Returns the selction object of the centerline
Created in NX6.0.0. More...
 
void RemoveLocation (int index)
 Removes location object for a given index from the Select Object List. More...
 
void SetFullCircle (bool fullType)
 Sets the method which returns full or partial circle flag
Created in NX6.0.0. More...
 
NXOpen::Annotations::CircleCenterlineSettingsBuilderSettings ()
 Returns the settings builder object for the centerline
Created in NX6.0.0. More...
 
void SetType (NXOpen::Annotations::CircleCenterlineBuilder::Types method)
 Sets the method which returns type of centerline
Created in NX6.0.0. More...
 
NXOpen::Annotations::CircleCenterlineBuilder::Types Type ()
 Returns the method which returns type of centerline
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

Represents a CircleCenterline Builder
This is an abstract class.


Default values.

Property Value

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


Created in NX6.0.0.

Member Enumeration Documentation

the valid enumeration used for the creation types, applicable only while creation Once created type centerpoint will be set for all bolt circle/circular centerline

Enumerator
TypesThrough3Points 

Centerline using 3 or More Points Method.

TypesCenterpoint 

Centerline using Centerpoint Method.

Member Function Documentation

bool NXOpen::Annotations::CircleCenterlineBuilder::FullCircle ( )

Returns the method which returns full or partial circle flag
Created in NX6.0.0.



License requirements : None

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

Returns the inherit object
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Annotations::CircleCenterlineBuilder::Locations ( )

Returns the selction object of the centerline
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::CircleCenterlineBuilder::RemoveLocation ( int  index)

Removes location object for a given index from the Select Object List.

This method is required for the retained circle centerline case , however the method can be used for removing any object from select object list for the Circle Centerline.
Created in NX6.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
indexIndex of the object in the select object list
void NXOpen::Annotations::CircleCenterlineBuilder::SetFullCircle ( bool  fullType)

Sets the method which returns full or partial circle flag
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
fullTypefulltype
NXOpen::Annotations::CircleCenterlineSettingsBuilder* NXOpen::Annotations::CircleCenterlineBuilder::Settings ( )

Returns the settings builder object for the centerline
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::CircleCenterlineBuilder::SetType ( NXOpen::Annotations::CircleCenterlineBuilder::Types  method)

Sets the method which returns type of centerline
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
methodmethod
NXOpen::Annotations::CircleCenterlineBuilder::Types NXOpen::Annotations::CircleCenterlineBuilder::Type ( )

Returns the method which returns type of centerline
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.