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

Represents a NXOpen::Annotations::OffsetCenterPoint builder
To create a new instance of this class, use NXOpen::Annotations::OffsetCenterPointCollection::CreateOffsetCenterPointBuilder
Default values. More...

Inheritance diagram for NXOpen::Annotations::OffsetCenterPointBuilder:
NXOpen::Annotations::BaseSymbolBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Display { DisplayCenterPoint, DisplayCenterLine, DisplayCenterLineWithExtension }
 the valid types of display styles More...
 
enum  Offset {
  OffsetHorizontalDistanceFromArc, OffsetHorizontalDistanceFromCenter, OffsetHorizontalDistanceByPosition, OffsetVerticalDistanceFromArc,
  OffsetVerticalDistanceFromCenter, OffsetVerticalDistanceByPosition
}
 the valid offset method types More...
 
enum  Thickness {
  ThicknessThin, ThicknessNormal, ThicknessThick, ThicknessOne = 6,
  ThicknessTwo, ThicknessThree, ThicknessFour, ThicknessFive,
  ThicknessSix, ThicknessSeven, ThicknessEight, ThicknessNine
}
 the valid types of offset center point thickness More...
 

Public Member Functions

double CenterCross ()
 Returns the center cross size
Created in NX6.0.0. More...
 
NXOpen::NXColorColor ()
 Returns the color
Created in NX6.0.0. More...
 
NXOpen::Annotations::OffsetCenterPointBuilder::Display DisplayStyle ()
 Returns the display style
Created in NX6.0.0. More...
 
double Distance ()
 Returns the offset distance, valid for all offset method types except those by position
Created in NX6.0.0. More...
 
double Extension ()
 Returns the extension
Created in NX6.0.0. More...
 
double Gap ()
 Returns the gap
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectInherit ()
 Returns the inherit
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectLocation ()
 Returns the location
Created in NX6.0.0. More...
 
NXOpen::Annotations::OffsetCenterPointBuilder::Offset OffsetMethod ()
 Returns the offset method
Created in NX6.0.0. More...
 
NXOpen::Point3d OffsetPosition ()
 Returns the offset position, valid for position offset methods
Created in NX6.0.0. More...
 
void SetCenterCross (double centerCross)
 Sets the center cross size
Created in NX6.0.0. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the color
Created in NX6.0.0. More...
 
void SetDisplayStyle (NXOpen::Annotations::OffsetCenterPointBuilder::Display display)
 Sets the display style
Created in NX6.0.0. More...
 
void SetDistance (double distance)
 Sets the offset distance, valid for all offset method types except those by position
Created in NX6.0.0. More...
 
void SetExtension (double extension)
 Sets the extension
Created in NX6.0.0. More...
 
void SetGap (double gap)
 Sets the gap
Created in NX6.0.0. More...
 
void SetOffsetMethod (NXOpen::Annotations::OffsetCenterPointBuilder::Offset offsetMethod)
 Sets the offset method
Created in NX6.0.0. More...
 
void SetOffsetPosition (const NXOpen::Point3d &point)
 Sets the offset position, valid for position offset methods
Created in NX6.0.0. More...
 
void SetWidth (NXOpen::Annotations::OffsetCenterPointBuilder::Thickness width)
 Sets the width
Created in NX6.0.0. More...
 
NXOpen::Annotations::OffsetCenterPointBuilder::Thickness Width ()
 Returns the width
Created in NX6.0.0. More...
 

Detailed Description

Represents a NXOpen::Annotations::OffsetCenterPoint builder
To create a new instance of this class, use NXOpen::Annotations::OffsetCenterPointCollection::CreateOffsetCenterPointBuilder
Default values.

Property Value

CenterCross

3.175 (millimeters part), 0.125 (inches part)

DisplayStyle

CenterPoint

Distance

0

Extension

6.35 (millimeters part), 0.25 (inches part)

Gap

1.5875 (millimeters part), 0.0625 (inches part)

OffsetMethod

HorizontalDistanceFromArc

Width

Thin


Created in NX6.0.0.

Member Enumeration Documentation

the valid types of display styles

Enumerator
DisplayCenterPoint 

center point

DisplayCenterLine 

center line

DisplayCenterLineWithExtension 

center line with extension

the valid offset method types

Enumerator
OffsetHorizontalDistanceFromArc 

horizontal distance from arc

OffsetHorizontalDistanceFromCenter 

horizontal distance from center

OffsetHorizontalDistanceByPosition 

horizontal distance by position, applicable only for creation

OffsetVerticalDistanceFromArc 

vertical distance from arc

OffsetVerticalDistanceFromCenter 

vertical distance from center

OffsetVerticalDistanceByPosition 

vertical distance by position, applicable only for creation

the valid types of offset center point thickness

Enumerator
ThicknessThin 

thin

ThicknessNormal 

normal

ThicknessThick 

thick

ThicknessOne 

Width One.

ThicknessTwo 

Width Two.

ThicknessThree 

Width Three.

ThicknessFour 

Width Four.

ThicknessFive 

Width Five.

ThicknessSix 

Width Six.

ThicknessSeven 

Width Seven.

ThicknessEight 

Width Eight.

ThicknessNine 

Width Nine.

Member Function Documentation

double NXOpen::Annotations::OffsetCenterPointBuilder::CenterCross ( )

Returns the center cross size
Created in NX6.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::Annotations::OffsetCenterPointBuilder::Color ( )

Returns the color
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::OffsetCenterPointBuilder::Display NXOpen::Annotations::OffsetCenterPointBuilder::DisplayStyle ( )

Returns the display style
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::OffsetCenterPointBuilder::Distance ( )

Returns the offset distance, valid for all offset method types except those by position
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::OffsetCenterPointBuilder::Extension ( )

Returns the extension
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::OffsetCenterPointBuilder::Gap ( )

Returns the gap
Created in NX6.0.0.



License requirements : None

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

Returns the inherit
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Annotations::OffsetCenterPointBuilder::Location ( )

Returns the location
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::OffsetCenterPointBuilder::Offset NXOpen::Annotations::OffsetCenterPointBuilder::OffsetMethod ( )

Returns the offset method
Created in NX6.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Annotations::OffsetCenterPointBuilder::OffsetPosition ( )

Returns the offset position, valid for position offset methods
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::OffsetCenterPointBuilder::SetCenterCross ( double  centerCross)

Sets the center cross size
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
centerCrosscentercross
void NXOpen::Annotations::OffsetCenterPointBuilder::SetColor ( NXOpen::NXColor color)

Sets the color
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
colorcolor
void NXOpen::Annotations::OffsetCenterPointBuilder::SetDisplayStyle ( NXOpen::Annotations::OffsetCenterPointBuilder::Display  display)

Sets the display style
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
displaydisplay
void NXOpen::Annotations::OffsetCenterPointBuilder::SetDistance ( double  distance)

Sets the offset distance, valid for all offset method types except those by position
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
distancedistance
void NXOpen::Annotations::OffsetCenterPointBuilder::SetExtension ( double  extension)

Sets the extension
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
extensionextension
void NXOpen::Annotations::OffsetCenterPointBuilder::SetGap ( double  gap)

Sets the gap
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
gapgap
void NXOpen::Annotations::OffsetCenterPointBuilder::SetOffsetMethod ( NXOpen::Annotations::OffsetCenterPointBuilder::Offset  offsetMethod)

Sets the offset method
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
offsetMethodoffsetmethod
void NXOpen::Annotations::OffsetCenterPointBuilder::SetOffsetPosition ( const NXOpen::Point3d point)

Sets the offset position, valid for position offset methods
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
pointpoint
void NXOpen::Annotations::OffsetCenterPointBuilder::SetWidth ( NXOpen::Annotations::OffsetCenterPointBuilder::Thickness  width)

Sets the width
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
widthwidth
NXOpen::Annotations::OffsetCenterPointBuilder::Thickness NXOpen::Annotations::OffsetCenterPointBuilder::Width ( )

Returns the width
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.