NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::RegionBuilder Class Reference

Represents a Annotations::RegionBuilder builder
To create a new instance of this class, use Annotations::PmiRegionCollection::CreateRegionBuilder
Default values. More...

Inheritance diagram for NXOpen::Annotations::RegionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  AlignmentPosition {
  AlignmentPositionTopLeft, AlignmentPositionTopCenter, AlignmentPositionTopRight, AlignmentPositionMiddleLeft,
  AlignmentPositionMiddleCenter, AlignmentPositionMiddleRight, AlignmentPositionBottomLeft, AlignmentPositionBottomCenter,
  AlignmentPositionBottomRight
}
 Specifies the anchor location of the region. More...
enum  CrosshatchPatterns { CrosshatchPatternsNone, CrosshatchPatternsGeneralUse }
 Specifies the crosshatch pattern. More...
enum  Types {
  TypesRectangularRegion, TypesCircularRegion, TypesAnnularRegion, TypesCylindricalRegion,
  TypesArbitraryRegion
}
 Specifies the region type. More...

Public Member Functions

NXOpen::Annotations::RegionBuilder::AlignmentPosition Anchor ()
 Returns the anchor Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
NXOpen::Annotations::ArbitraryAreaSeedBuilderListArbitraryAreaList ()
 Returns the arbitrary area list Only available when the region type is Annotations::RegionBuilder::TypesArbitraryRegion
Created in NX6.0.0.
bool ConformToSurface ()
 Returns the conform to surface toggle Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
NXOpen::ExpressionCrosshatchAngle ()
 Returns the crosshatch angle
Created in NX6.0.0.
NXOpen::NXColorCrosshatchColor ()
 Returns the crosshatch color
Created in NX6.0.0.
NXOpen::ExpressionCrosshatchDistance ()
 Returns the crosshatch distance
Created in NX6.0.0.
NXOpen::Annotations::RegionBuilder::CrosshatchPatterns CrosshatchPattern ()
 Returns the crosshatch pattern enum
Created in NX6.0.0.
NXOpen::PointEndPoint ()
 Returns the end point Only available when the region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.
NXOpen::ExpressionHeight ()
 Returns the height Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion
Created in NX6.0.0.
NXOpen::ExpressionInnerDiameter ()
 Returns the inner diameter Only available when region type is Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
NXOpen::PointOrigin ()
 Returns the origin Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
NXOpen::ExpressionOuterDiameter ()
 Returns the outer diameter Only available when region type is Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
NXOpen::Annotations::PlaneBuilderPlane ()
 Returns the plane
Created in NX6.0.0.
NXOpen::SelectDisplayableObjectListSelectCylindricalFace ()
 Returns the select cylindrical face Only available when region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.
NXOpen::SelectDisplayableObjectListSelectFace ()
 Returns the select face Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
void SetAnchor (NXOpen::Annotations::RegionBuilder::AlignmentPosition anchor)
 Sets the anchor Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
void SetConformToSurface (bool conformToSurfaceToggle)
 Sets the conform to surface toggle Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
void SetCrosshatchColor (NXOpen::NXColor *crosshatchColor)
 Sets the crosshatch color
Created in NX6.0.0.
void SetCrosshatchPattern (NXOpen::Annotations::RegionBuilder::CrosshatchPatterns crosshatchPattern)
 Sets the crosshatch pattern enum
Created in NX6.0.0.
void SetEndPoint (NXOpen::Point *endPoint)
 Sets the end point Only available when the region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.
void SetOrigin (NXOpen::Point *origin)
 Sets the origin Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.
void SetStartPoint (NXOpen::Point *startPoint)
 Sets the start point Only available when the region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.
void SetType (NXOpen::Annotations::RegionBuilder::Types type)
 Sets the type
Created in NX6.0.0.
NXOpen::PointStartPoint ()
 Returns the start point Only available when the region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.
NXOpen::Annotations::RegionBuilder::Types Type ()
 Returns the type
Created in NX6.0.0.
NXOpen::ExpressionWidth ()
 Returns the width Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion
Created in NX6.0.0.

Detailed Description

Represents a Annotations::RegionBuilder builder
To create a new instance of this class, use Annotations::PmiRegionCollection::CreateRegionBuilder
Default values.

Property Value

ConformToSurface

0


Created in NX6.0.0.


Member Enumeration Documentation

Specifies the anchor location of the region.

Enumerator:
AlignmentPositionTopLeft 

top left

AlignmentPositionTopCenter 

top center

AlignmentPositionTopRight 

top right

AlignmentPositionMiddleLeft 

middle left

AlignmentPositionMiddleCenter 

middle center

AlignmentPositionMiddleRight 

middle right

AlignmentPositionBottomLeft 

bottom left

AlignmentPositionBottomCenter 

bottom center

AlignmentPositionBottomRight 

bottom right

Specifies the crosshatch pattern.

Enumerator:
CrosshatchPatternsNone 

none

CrosshatchPatternsGeneralUse 

general use

Specifies the region type.

Enumerator:
TypesRectangularRegion 

rectangular

TypesCircularRegion 

circular

TypesAnnularRegion 

annular

TypesCylindricalRegion 

cylindrical

TypesArbitraryRegion 

arbitrary


Member Function Documentation

Returns the anchor Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : None

Returns the arbitrary area list Only available when the region type is Annotations::RegionBuilder::TypesArbitraryRegion
Created in NX6.0.0.



License requirements : None

Returns the conform to surface toggle Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : None

Returns the crosshatch angle
Created in NX6.0.0.



License requirements : None

Returns the crosshatch color
Created in NX6.0.0.



License requirements : None

Returns the crosshatch distance
Created in NX6.0.0.



License requirements : None

Returns the crosshatch pattern enum
Created in NX6.0.0.



License requirements : None

Returns the end point Only available when the region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.



License requirements : None

Returns the height Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion
Created in NX6.0.0.



License requirements : None

Returns the inner diameter Only available when region type is Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : None

Returns the origin Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : None

Returns the outer diameter Only available when region type is Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : None

Returns the plane
Created in NX6.0.0.



License requirements : None

Returns the select cylindrical face Only available when region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.



License requirements : None

Returns the select face Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : None

Sets the anchor Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
anchoranchor
void NXOpen::Annotations::RegionBuilder::SetConformToSurface ( bool  conformToSurfaceToggle)

Sets the conform to surface toggle Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
conformToSurfaceToggleconformtosurfacetoggle

Sets the crosshatch color
Created in NX6.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
crosshatchColorcrosshatchcolor

Sets the crosshatch pattern enum
Created in NX6.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
crosshatchPatterncrosshatchpattern

Sets the end point Only available when the region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
endPointendpoint

Sets the origin Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion , Annotations::RegionBuilder::TypesCircularRegion , Annotations::RegionBuilder::TypesAnnularRegion
Created in NX6.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
originorigin

Sets the start point Only available when the region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
startPointstartpoint

Sets the type
Created in NX6.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
typetype

Returns the start point Only available when the region type is Annotations::RegionBuilder::TypesCylindricalRegion
Created in NX6.0.0.



License requirements : None

Returns the type
Created in NX6.0.0.



License requirements : None

Returns the width Only available when region type is Annotations::RegionBuilder::TypesRectangularRegion
Created in NX6.0.0.



License requirements : None


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