NXOpen::Diagramming::SheetElementBuilder Class Reference

Represents a SheetElementBuilder. More...

Inheritance diagram for NXOpen::Diagramming::SheetElementBuilder:

Public Types
enum	ResizeOptionType {   ResizeOptionTypeAnyDirection, ResizeOptionTypeOnAnchor, ResizeOptionTypeSameRatio, ResizeOptionTypeSameRationOnCorner,   ResizeOptionTypeSameRatioOnEdge }
	Represents the resize option for a NXOpen::Diagramming::SheetElementBuilder . More...

Public Member Functions
void	GetAllowedTransformations (bool *isAllowedTranslation, bool *isAllowedRotation, bool *isAllowedScale, bool *isAllowedShear)
	Get the allowed transformations of the sheet element. More...
void	GetMinNodeSize (std::vector< double > &sizeValues)
	Gets the minimum node size values Created in NX11.0.0. More...
double	Height ()
	Returns the height. More...
NXOpen::Diagramming::DiagrammingSizingpolicy	HeightPolicy ()
	Returns the height policy. More...
bool	Internal ()
	Returns the flag that indicates if the sheet element is internal. More...
NXOpen::Diagramming::Annotation *	Label ()
	Returns the label of this sheet element. More...
NXString	LabelName ()
	Returns the label name of this sheet element. More...
NXOpen::Diagramming::LocationBuilder *	Location ()
	Returns the location of the sheet element relative to another sheet element. More...
NXOpen::Diagramming::DiagrammingLocationstyle	LocationStyle ()
	Returns the location style. More...
bool	MirrorX ()
	Returns the sheet element to Mirror along the X axis. More...
bool	MirrorY ()
	Returns the sheet element to Mirror along the Y axis. More...
NXOpen::Diagramming::SheetElement *	Owner ()
	Returns the owning sheet element. More...
NXOpen::Diagramming::Sheet *	OwningSheet ()
	Returns the owning sheet. More...
NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType	ResizeOption ()
	Returns the resize option of the sheet element Created in NX11.0.0. More...
double	Rotation ()
	Returns the rotation angle that is counter clockwise and relative to the owner. More...
void	SetHeight (double height)
	Sets the height. More...
void	SetHeightPolicy (NXOpen::Diagramming::DiagrammingSizingpolicy heightPolicy)
	Sets the height policy. More...
void	SetLabelName (const NXString &labelname)
	Sets the label name of this sheet element. More...
void	SetLabelName (const char *labelname)
	Sets the label name of this sheet element. More...
void	SetLocationStyle (NXOpen::Diagramming::DiagrammingLocationstyle locationStyle)
	Sets the location style. More...
void	SetMinNodeSize (const std::vector< double > &sizeValues)
	Sets the minimum node size values Created in NX11.0.0. More...
void	SetMirrorX (bool mirrorX)
	Sets the sheet element to Mirror along the X axis. More...
void	SetMirrorY (bool mirrorY)
	Sets the sheet element to Mirror along the Y axis. More...
void	SetOwner (NXOpen::Diagramming::SheetElement *owner)
	Sets the owning sheet element. More...
void	SetOwningSheet (NXOpen::Diagramming::Sheet *owningSheet)
	Set the owning sheet when the sheet element is created. More...
void	SetResizeOption (NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType resizeOption)
	Sets the resize option of the sheet element Created in NX11.0.0. More...
void	SetRotation (double angle)
	Sets the rotation angle that is counter clockwise and relative to the owner. More...
void	SetWidth (double width)
	Sets the width. More...
void	SetWidthPolicy (NXOpen::Diagramming::DiagrammingSizingpolicy widthPolicy)
	Sets the width policy. More...
void	SetX (double x)
	Sets the absolute x coordinate. More...
void	SetY (double y)
	Sets the absolute y coordinate. More...
void	SetZDepth (int zDepth)
	Sets the Z depth. More...
NXOpen::Diagramming::SheetElement *	SourceElement ()
	Returns the source element that records which sheet element it is a copy of. More...
bool	UpToDate ()
	Returns the flag that indicates if the sheet element is up to date. More...
bool	Visible ()
	Returns the flag that indicates if the sheet element is visible. More...
double	Width ()
	Returns the width. More...
NXOpen::Diagramming::DiagrammingSizingpolicy	WidthPolicy ()
	Returns the width policy. More...
double	X ()
	Returns the absolute x coordinate. More...
double	Y ()
	Returns the absolute y coordinate. More...
int	ZDepth ()
	Returns the Z depth. More...

Detailed Description

Represents a SheetElementBuilder.

This is an abstract class and cannot be directly instantiated

Created in NX10.0.0.

Member Enumeration Documentation

enum NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType

Represents the resize option for a NXOpen::Diagramming::SheetElementBuilder .

Created in NX11.0.0.

Enumerator
ResizeOptionTypeAnyDirection	any direction
ResizeOptionTypeOnAnchor	on anchor
ResizeOptionTypeSameRatio	same ratio
ResizeOptionTypeSameRationOnCorner	same ration on corner
ResizeOptionTypeSameRatioOnEdge	same ratio on edge

Member Function Documentation

void NXOpen::Diagramming::SheetElementBuilder::GetAllowedTransformations	(	bool *	isAllowedTranslation,
		bool *	isAllowedRotation,
		bool *	isAllowedScale,
		bool *	isAllowedShear
	)

Get the allowed transformations of the sheet element.

Created in NX10.0.0.

License requirements : None

Parameters

isAllowedTranslation	isallowedtranslation
isAllowedRotation	isallowedrotation
isAllowedScale	isallowedscale
isAllowedShear	isallowedshear

void NXOpen::Diagramming::SheetElementBuilder::GetMinNodeSize

(

std::vector< double > &

sizeValues

)

Gets the minimum node size values
Created in NX11.0.0.

License requirements : None

Parameters

sizeValues

Minimum node size values as output

double NXOpen::Diagramming::SheetElementBuilder::Height

(

)

Returns the height.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::DiagrammingSizingpolicy NXOpen::Diagramming::SheetElementBuilder::HeightPolicy

(

)

Returns the height policy.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetElementBuilder::Internal

(

)

Returns the flag that indicates if the sheet element is internal.

If false it is not part of the user's data model; for example, an Annotation is not part of the user's model of Nodes and Connections.
Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::Annotation* NXOpen::Diagramming::SheetElementBuilder::Label

(

)

Returns the label of this sheet element.

Created in NX10.0.0.

License requirements : None

NXString NXOpen::Diagramming::SheetElementBuilder::LabelName

(

)

Returns the label name of this sheet element.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::LocationBuilder* NXOpen::Diagramming::SheetElementBuilder::Location

(

)

Returns the location of the sheet element relative to another sheet element.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::DiagrammingLocationstyle NXOpen::Diagramming::SheetElementBuilder::LocationStyle

(

)

Returns the location style.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetElementBuilder::MirrorX

(

)

Returns the sheet element to Mirror along the X axis.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetElementBuilder::MirrorY

(

)

Returns the sheet element to Mirror along the Y axis.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::SheetElement* NXOpen::Diagramming::SheetElementBuilder::Owner

(

)

Returns the owning sheet element.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::Sheet* NXOpen::Diagramming::SheetElementBuilder::OwningSheet

(

)

Returns the owning sheet.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType NXOpen::Diagramming::SheetElementBuilder::ResizeOption

(

)

Returns the resize option of the sheet element
Created in NX11.0.0.

License requirements : None

double NXOpen::Diagramming::SheetElementBuilder::Rotation

(

)

Returns the rotation angle that is counter clockwise and relative to the owner.

Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::SheetElementBuilder::SetHeight

(

double

height

)

Sets the height.

Created in NX10.0.0.

License requirements : None

Parameters

height

height

void NXOpen::Diagramming::SheetElementBuilder::SetHeightPolicy

(

NXOpen::Diagramming::DiagrammingSizingpolicy

heightPolicy

)

Sets the height policy.

Created in NX10.0.0.

License requirements : None

Parameters

heightPolicy

heightpolicy

void NXOpen::Diagramming::SheetElementBuilder::SetLabelName

(

const NXString &

labelname

)

Sets the label name of this sheet element.

Created in NX10.0.0.

License requirements : None

Parameters

labelname

labelname

void NXOpen::Diagramming::SheetElementBuilder::SetLabelName

(

const char *

labelname

)

Sets the label name of this sheet element.

Created in NX10.0.0.

License requirements : None

Parameters

labelname

labelname

void NXOpen::Diagramming::SheetElementBuilder::SetLocationStyle

(

NXOpen::Diagramming::DiagrammingLocationstyle

locationStyle

)

Sets the location style.

Created in NX10.0.0.

License requirements : None

Parameters

locationStyle

locationstyle

void NXOpen::Diagramming::SheetElementBuilder::SetMinNodeSize

(

const std::vector< double > &

sizeValues

)

Sets the minimum node size values
Created in NX11.0.0.

License requirements : None

Parameters

sizeValues

Minimum node size values as input

void NXOpen::Diagramming::SheetElementBuilder::SetMirrorX

(

bool

mirrorX

)

Sets the sheet element to Mirror along the X axis.

Created in NX10.0.0.

License requirements : None

Parameters

mirrorX

mirrorx

void NXOpen::Diagramming::SheetElementBuilder::SetMirrorY

(

bool

mirrorY

)

Sets the sheet element to Mirror along the Y axis.

Created in NX10.0.0.

License requirements : None

Parameters

mirrorY

mirrory

void NXOpen::Diagramming::SheetElementBuilder::SetOwner

(

NXOpen::Diagramming::SheetElement *

owner

)

Sets the owning sheet element.

Created in NX10.0.0.

License requirements : None

Parameters

owner

owner

void NXOpen::Diagramming::SheetElementBuilder::SetOwningSheet

(

NXOpen::Diagramming::Sheet *

owningSheet

)

Set the owning sheet when the sheet element is created.

It is not allowed to change the owning sheet when editing the sheet element.
Created in NX10.0.0.

License requirements : None

Parameters

owningSheet

owningsheet

void NXOpen::Diagramming::SheetElementBuilder::SetResizeOption

(

NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType

resizeOption

)

Sets the resize option of the sheet element
Created in NX11.0.0.

License requirements : None

Parameters

resizeOption

resizeoption

void NXOpen::Diagramming::SheetElementBuilder::SetRotation

(

double

angle

)

Sets the rotation angle that is counter clockwise and relative to the owner.

Created in NX10.0.0.

License requirements : None

Parameters

angle

angle

void NXOpen::Diagramming::SheetElementBuilder::SetWidth

(

double

width

)

Sets the width.

Created in NX10.0.0.

License requirements : None

Parameters

width

width

void NXOpen::Diagramming::SheetElementBuilder::SetWidthPolicy

(

NXOpen::Diagramming::DiagrammingSizingpolicy

widthPolicy

)

Sets the width policy.

Created in NX10.0.0.

License requirements : None

Parameters

widthPolicy

widthpolicy

void NXOpen::Diagramming::SheetElementBuilder::SetX

(

double

x

)

Sets the absolute x coordinate.

Created in NX10.0.0.

License requirements : None

Parameters

x

x

void NXOpen::Diagramming::SheetElementBuilder::SetY

(

double

y

)

Sets the absolute y coordinate.

Created in NX10.0.0.

License requirements : None

Parameters

y

y

void NXOpen::Diagramming::SheetElementBuilder::SetZDepth

(

int

zDepth

)

Sets the Z depth.

Higher values of the Z depth indicates that the object is rendered on top of objects with a lower value.
Created in NX10.0.0.

License requirements : None

Parameters

zDepth

zdepth

NXOpen::Diagramming::SheetElement* NXOpen::Diagramming::SheetElementBuilder::SourceElement

(

)

Returns the source element that records which sheet element it is a copy of.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetElementBuilder::UpToDate

(

)

Returns the flag that indicates if the sheet element is up to date.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetElementBuilder::Visible

(

)

Returns the flag that indicates if the sheet element is visible.

If true it is visible.
Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetElementBuilder::Width

(

)

Returns the width.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::DiagrammingSizingpolicy NXOpen::Diagramming::SheetElementBuilder::WidthPolicy

(

)

Returns the width policy.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetElementBuilder::X

(

)

Returns the absolute x coordinate.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetElementBuilder::Y

(

)

Returns the absolute y coordinate.

Created in NX10.0.0.

License requirements : None

int NXOpen::Diagramming::SheetElementBuilder::ZDepth

(

)

Returns the Z depth.

Higher values of the Z depth indicates that the object is rendered on top of objects with a lower value.
Created in NX10.0.0.

License requirements : None

---

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

• Diagramming_SheetElementBuilder.hxx