Represents a Drawing Region Builder  <br> To create a new instance of this class, use @link Drawings::DrawingRegionCollection::CreateDrawingRegionBuilder  Drawings::DrawingRegionCollection::CreateDrawingRegionBuilder @endlink  <br>

Default values. More...

Inheritance diagram for NXOpen::Drawings::DrawingRegionBuilder:

Public Types
enum	ContentToMove { ContentToMoveAll, ContentToMoveOnlyOverlapping }
	Specifies the region content to move. More...

enum	RegionContinuation { RegionContinuationNone, RegionContinuationNewSheet, RegionContinuationNextRegion, RegionContinuationNewSheetRight, RegionContinuationNewSheetLeft, RegionContinuationNewSheetUp, RegionContinuationNewSheetDown }
	Specifies the region continuation type. More...

enum	RegionDraftingObjectType { RegionDraftingObjectTypeView, RegionDraftingObjectTypeTable, RegionDraftingObjectTypeAnnotation, RegionDraftingObjectTypeSymbol, RegionDraftingObjectTypeBlank, RegionDraftingObjectTypeNone }
	Specifies the drafting object type. More...

enum	RegionGrowthDirection { RegionGrowthDirectionRightfromTopLeft, RegionGrowthDirectionRightfromBottomLeft, RegionGrowthDirectionLeftfromTopRight, RegionGrowthDirectionLeftfromBottomRight, RegionGrowthDirectionDownfromTopLeft, RegionGrowthDirectionDownfromTopRight, RegionGrowthDirectionUpfromBottomLeft, RegionGrowthDirectionUpfromBottomRight, RegionGrowthDirectionNone }
	Specifies the region growth direction (this is for Annotations::CustomSymbol and Annotations::Note ) More...

enum	RegionHorizontalGrowthDirection { RegionHorizontalGrowthDirectionLeft, RegionHorizontalGrowthDirectionRight }
	Specifies the region horizontal growth direction. More...

enum	RegionVerticalGrowthDirection { RegionVerticalGrowthDirectionUp, RegionVerticalGrowthDirectionDown }
	Specifies the region vertical growth direction. More...

Public Member Functions
NXOpen::Drawings::DrawingRegionRulesBuilder *	DrawingRegionRulesBuilder ()
	Returns the DrawingRegionRules builder Created in NX8.0.0.

double	Gap ()
	Returns the gap Created in NX8.0.0.

NXOpen::Drawings::DrawingRegionBuilder::RegionGrowthDirection	GrowthDirection ()
	Returns the growth direction (this is for Annotations::CustomSymbol and Annotations::Note ) Created in NX8.0.0.

NXOpen::Expression *	Height ()
	Returns the height Created in NX8.0.0.

NXOpen::Drawings::DrawingRegionBuilder::RegionHorizontalGrowthDirection	HorizontalGrowthDirection ()
	Returns the horizantal growth direction Created in NX8.0.0.

NXOpen::Expression *	Length ()
	Returns the length Created in NX8.0.0.

NXOpen::Drawings::DrawingRegionBuilder::ContentToMove	MoveContent ()
	Returns the move content Created in NX8.0.0.

NXString	Name ()
	Returns the name Created in NX8.0.0.

NXOpen::Drawings::DrawingRegionBuilder::RegionDraftingObjectType	ObjectType ()
	Returns the type Created in NX8.0.0.

NXOpen::Point *	Origin ()
	Returns the origin Created in NX8.0.0.

int	Priority ()
	Returns the priority Created in NX8.0.0.

void	SetGap (double gap)
	Sets the gap Created in NX8.0.0.

void	SetGrowthDirection (NXOpen::Drawings::DrawingRegionBuilder::RegionGrowthDirection growthDirection)
	Sets the growth direction (this is for Annotations::CustomSymbol and Annotations::Note ) Created in NX8.0.0.

void	SetHorizontalGrowthDirection (NXOpen::Drawings::DrawingRegionBuilder::RegionHorizontalGrowthDirection horizontalGrowthDirection)
	Sets the horizantal growth direction Created in NX8.0.0.

void	SetMoveContent (NXOpen::Drawings::DrawingRegionBuilder::ContentToMove moveContent)
	Sets the move content Created in NX8.0.0.

void	SetName (const NXString &name)
	Sets the name Created in NX8.0.0.

void	SetName (const char *name)
	Sets the name Created in NX8.0.0.

void	SetNextLinkedRegion (NXOpen::Drawings::DrawingRegion *nextLinkedRegion)
	Set the next linked regions Created in NX8.0.0.

void	SetObjectType (NXOpen::Drawings::DrawingRegionBuilder::RegionDraftingObjectType type)
	Sets the type Created in NX8.0.0.

void	SetOrigin (NXOpen::Point *origin)
	Sets the origin Created in NX8.0.0.

void	SetPriority (int priority)
	Sets the priority Created in NX8.0.0.

void	SetSpecifyContinuation (NXOpen::Drawings::DrawingRegionBuilder::RegionContinuation specifyContinuation)
	Sets the continuation Created in NX8.0.0.

void	SetVerticalGrowthDirection (NXOpen::Drawings::DrawingRegionBuilder::RegionVerticalGrowthDirection verticalGrowthDirection)
	Sets the vertical growth direction Created in NX8.0.0.

NXOpen::Drawings::DrawingRegionBuilder::RegionContinuation	SpecifyContinuation ()
	Returns the continuation Created in NX8.0.0.

NXOpen::Drawings::DrawingRegionBuilder::RegionVerticalGrowthDirection	VerticalGrowthDirection ()
	Returns the vertical growth direction Created in NX8.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Drawing Region Builder  <br> To create a new instance of this class, use @link Drawings::DrawingRegionCollection::CreateDrawingRegionBuilder  Drawings::DrawingRegionCollection::CreateDrawingRegionBuilder @endlink  <br>

Default values.

Property

Value

Gap

0

GrowthDirection

RightfromTopLeft

Height.Value

0 (millimeters part), 0 (inches part)

HorizontalGrowthDirection

Left

Length.Value

0 (millimeters part), 0 (inches part)

MoveContent

All

ObjectType

View

Priority

0

SpecifyContinuation

None

VerticalGrowthDirection

Up

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::DrawingRegionBuilder::ContentToMove

Specifies the region content to move.

Enumerator:

ContentToMoveAll	all
ContentToMoveOnlyOverlapping	only overlapping

enum NXOpen::Drawings::DrawingRegionBuilder::RegionContinuation

Specifies the region continuation type.

Enumerator:

RegionContinuationNone	none
RegionContinuationNewSheet	new sheet
RegionContinuationNextRegion	next region
RegionContinuationNewSheetRight	new sheet right
RegionContinuationNewSheetLeft	new sheet left
RegionContinuationNewSheetUp	new sheet up
RegionContinuationNewSheetDown	new sheet down

enum NXOpen::Drawings::DrawingRegionBuilder::RegionDraftingObjectType

Specifies the drafting object type.

Enumerator:

RegionDraftingObjectTypeView	view
RegionDraftingObjectTypeTable	table
RegionDraftingObjectTypeAnnotation	annotation
RegionDraftingObjectTypeSymbol	symbol
RegionDraftingObjectTypeBlank	blank
RegionDraftingObjectTypeNone	none

enum NXOpen::Drawings::DrawingRegionBuilder::RegionGrowthDirection

Specifies the region growth direction (this is for Annotations::CustomSymbol and Annotations::Note )

Enumerator:

RegionGrowthDirectionRightfromTopLeft	rightfrom top left
RegionGrowthDirectionRightfromBottomLeft	rightfrom bottom left
RegionGrowthDirectionLeftfromTopRight	leftfrom top right
RegionGrowthDirectionLeftfromBottomRight	leftfrom bottom right
RegionGrowthDirectionDownfromTopLeft	downfrom top left
RegionGrowthDirectionDownfromTopRight	downfrom top right
RegionGrowthDirectionUpfromBottomLeft	upfrom bottom left
RegionGrowthDirectionUpfromBottomRight	upfrom bottom right
RegionGrowthDirectionNone	none

enum NXOpen::Drawings::DrawingRegionBuilder::RegionHorizontalGrowthDirection

Specifies the region horizontal growth direction.

Enumerator:

RegionHorizontalGrowthDirectionLeft	left
RegionHorizontalGrowthDirectionRight	right

enum NXOpen::Drawings::DrawingRegionBuilder::RegionVerticalGrowthDirection

Specifies the region vertical growth direction.

Enumerator:

RegionVerticalGrowthDirectionUp	up
RegionVerticalGrowthDirectionDown	down

Member Function Documentation

NXOpen::Drawings::DrawingRegionRulesBuilder* NXOpen::Drawings::DrawingRegionBuilder::DrawingRegionRulesBuilder ( )

Returns the DrawingRegionRules builder
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

double NXOpen::Drawings::DrawingRegionBuilder::Gap ( )

Returns the gap
Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::DrawingRegionBuilder::RegionGrowthDirection NXOpen::Drawings::DrawingRegionBuilder::GrowthDirection ( )

Returns the growth direction (this is for Annotations::CustomSymbol and Annotations::Note )
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Drawings::DrawingRegionBuilder::Height ( )

Returns the height
Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::DrawingRegionBuilder::RegionHorizontalGrowthDirection NXOpen::Drawings::DrawingRegionBuilder::HorizontalGrowthDirection ( )

Returns the horizantal growth direction
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Drawings::DrawingRegionBuilder::Length ( )

Returns the length
Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::DrawingRegionBuilder::ContentToMove NXOpen::Drawings::DrawingRegionBuilder::MoveContent ( )

Returns the move content
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drawings::DrawingRegionBuilder::Name ( )

Returns the name
Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::DrawingRegionBuilder::RegionDraftingObjectType NXOpen::Drawings::DrawingRegionBuilder::ObjectType ( )

Returns the type
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXOpen::Point* NXOpen::Drawings::DrawingRegionBuilder::Origin ( )

Returns the origin
Created in NX8.0.0.

License requirements : None

int NXOpen::Drawings::DrawingRegionBuilder::Priority ( )

Returns the priority
Created in NX8.0.0.

License requirements : None

void NXOpen::Drawings::DrawingRegionBuilder::SetGap ( double gap )

Sets the gap
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

gap gap

void NXOpen::Drawings::DrawingRegionBuilder::SetGrowthDirection ( NXOpen::Drawings::DrawingRegionBuilder::RegionGrowthDirection growthDirection )

Sets the growth direction (this is for Annotations::CustomSymbol and Annotations::Note )
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

growthDirection growthdirection

void NXOpen::Drawings::DrawingRegionBuilder::SetHorizontalGrowthDirection ( NXOpen::Drawings::DrawingRegionBuilder::RegionHorizontalGrowthDirection horizontalGrowthDirection )

Sets the horizantal growth direction
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

horizontalGrowthDirection horizontalgrowthdirection

void NXOpen::Drawings::DrawingRegionBuilder::SetMoveContent ( NXOpen::Drawings::DrawingRegionBuilder::ContentToMove moveContent )

Sets the move content
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

moveContent movecontent

void NXOpen::Drawings::DrawingRegionBuilder::SetName ( const NXString & name )

Sets the name
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

name name

void NXOpen::Drawings::DrawingRegionBuilder::SetName ( const char * name )

Sets the name
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

name name

void NXOpen::Drawings::DrawingRegionBuilder::SetNextLinkedRegion ( NXOpen::Drawings::DrawingRegion * nextLinkedRegion )

Set the next linked regions
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

nextLinkedRegion nextlinkedregion

void NXOpen::Drawings::DrawingRegionBuilder::SetObjectType ( NXOpen::Drawings::DrawingRegionBuilder::RegionDraftingObjectType type )

Sets the type
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

type type

void NXOpen::Drawings::DrawingRegionBuilder::SetOrigin ( NXOpen::Point * origin )

Sets the origin
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

origin origin

void NXOpen::Drawings::DrawingRegionBuilder::SetPriority ( int priority )

Sets the priority
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

priority priority

void NXOpen::Drawings::DrawingRegionBuilder::SetSpecifyContinuation ( NXOpen::Drawings::DrawingRegionBuilder::RegionContinuation specifyContinuation )

Sets the continuation
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

specifyContinuation specifycontinuation

void NXOpen::Drawings::DrawingRegionBuilder::SetVerticalGrowthDirection ( NXOpen::Drawings::DrawingRegionBuilder::RegionVerticalGrowthDirection verticalGrowthDirection )

Sets the vertical growth direction
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

verticalGrowthDirection verticalgrowthdirection

NXOpen::Drawings::DrawingRegionBuilder::RegionContinuation NXOpen::Drawings::DrawingRegionBuilder::SpecifyContinuation ( )

Returns the continuation
Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::DrawingRegionBuilder::RegionVerticalGrowthDirection NXOpen::Drawings::DrawingRegionBuilder::VerticalGrowthDirection ( )

Returns the vertical growth direction
Created in NX8.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Drawings_DrawingRegionBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation