This builder is used to create/edit Reference Geometry
To create a new instance of this class, use NXOpen::Diagramming::SmartDiagrammingManager::CreateReferenceGeometryBuilder

Created in NX1847.0.0. More...

Inheritance diagram for NXOpen::Diagramming::ReferenceGeometryBuilder:

Public Member Functions
bool	DisplayBorder ()
	Returns the setting that determines whether the border should be displayed or not. More...

virtual NXOpen::ExternalFileReferenceAdapter *	EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const NXString &externalFileSpec)
	Establish the external reference to the given file specification. More...

virtual NXOpen::ExternalFileReferenceAdapter *	EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const char *externalFileSpec)
	Establish the external reference to the given file specification. More...

std::vector< double >	GetColor ()
	Gets the color. More...

virtual NXString	GetExternalFileDefinitionKey (NXOpen::ExternalFileReferenceAdapter *adapter)
	Gets the file definition to use for external file adapter. More...

virtual NXOpen::ExternalFileReferenceAdapter *	GetExternalFileReferenceAdapter (int referenceObjectId)
	Returns the external file reference object. More...

void	RefreshFromView (bool refresh)
	When set will cause a refresh of the geometry from the drawing view during commit. More...

double	Scale ()
	Returns the scale Created in NX1847.0.0. More...

void	SetColor (const std::vector< double > &color)
	Sets the color Created in NX1847.0.0. More...

void	SetDisplayBorder (bool displayBorder)
	Sets the setting that determines whether the border should be displayed or not. More...

virtual void	SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter *adapter)
	Sets the external file reference object. More...

void	SetScale (double scale)
	Sets the scale Created in NX1847.0.0. More...

void	SetTransparency (int transparency)
	Sets the transparency (between 0 and 100) Created in NX1847.0.0. More...

void	SetView (const NXString &viewIdentifier)
	Sets the view to import from Created in NX1847.0.0. More...

void	SetView (const char *viewIdentifier)
	Sets the view to import from Created in NX1847.0.0. More...

int	Transparency ()
	Returns the transparency (between 0 and 100) Created in NX1847.0.0. More...

NXString	View ()
	Returns the view to import from Created in NX1847.0.0. More...

Public Member Functions inherited from NXOpen::Diagramming::AnnotationBuilder
bool	BoundaryDisplay ()
	Returns the visibility of boundary. More...

NXOpen::Diagramming::DiagrammingAnnotationboundarytype	BoundaryType ()
	Returns the boundary type of the annotation Created in NX10.0.0. More...

NXOpen::Diagramming::FormattedStringBuilder *	FormattedStringBuilder ()
	Returns the formatted string of the text. More...

void	SetBoundaryDisplay (bool boundaryDisplay)
	Sets the visibility of boundary. More...

void	SetBoundaryType (NXOpen::Diagramming::DiagrammingAnnotationboundarytype boundaryType)
	Sets the boundary type of the annotation Created in NX10.0.0. More...

void	SetText (const NXString &strValue)
	Sets the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

void	SetText (const char *strValue)
	Sets the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

void	SetTextType (NXOpen::Diagramming::AnnotationBuilder::TextTypeOption textType)
	Sets the text type. More...

NXString	Text ()
	Returns the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

NXOpen::Diagramming::TextStyleBuilder *	TextStyleBuilder ()
	Returns the text style of the annotation. More...

NXOpen::Diagramming::AnnotationBuilder::TextTypeOption	TextType ()
	Returns the text type. More...

Public Member Functions inherited from NXOpen::Diagramming::ConnectableElementBuilder
std::vector < NXOpen::Diagramming::Port * >	GetAllPorts ()
	Gets all ports of this connectable element. More...

std::vector < NXOpen::Diagramming::Port * >	GetPorts (NXOpen::Diagramming::Direction direction)
	Gets ports of this connectable element by the direction. More...

Public Member Functions inherited from NXOpen::Diagramming::SheetElementBuilder
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...

Additional Inherited Members
Public Types inherited from NXOpen::Diagramming::AnnotationBuilder
enum	TextTypeOption { TextTypeOptionFixed, TextTypeOptionParametric }
	Represents the option NXOpen::Diagramming::AnnotationBuilder::TextType for a NXOpen::Diagramming::AnnotationBuilder . More...

Detailed Description

This builder is used to create/edit Reference Geometry
To create a new instance of this class, use NXOpen::Diagramming::SmartDiagrammingManager::CreateReferenceGeometryBuilder

Created in NX1847.0.0.

Member Function Documentation

bool NXOpen::Diagramming::ReferenceGeometryBuilder::DisplayBorder ( )

Returns the setting that determines whether the border should be displayed or not.

Created in NX1847.0.0.

License requirements : None

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Diagramming::ReferenceGeometryBuilder::EstablishReference	(	int	referenceObjectId,
		NXOpen::ExternalFileReferenceAdapter::Type	referenceType,
		const NXString &	externalFileSpec
	)

virtual

Establish the external reference to the given file specification.

Returns: external file reference object
Created in NX1847.0.0.

License requirements : None

Parameters

referenceObjectId	the unique identifier to use for this reference if referencer has multiple external references
referenceType	the kind of reference to establish
externalFileSpec	the external file specification.

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Diagramming::ReferenceGeometryBuilder::EstablishReference	(	int	referenceObjectId,
		NXOpen::ExternalFileReferenceAdapter::Type	referenceType,
		const char *	externalFileSpec
	)

virtual

Establish the external reference to the given file specification.

Returns: external file reference object
Created in NX1847.0.0.

License requirements : None

Parameters

referenceObjectId	the unique identifier to use for this reference if referencer has multiple external references
referenceType	the kind of reference to establish
externalFileSpec	the external file specification.

Implements NXOpen::IExternalFileReferencer.

std::vector<double> NXOpen::Diagramming::ReferenceGeometryBuilder::GetColor ( )

Gets the color.

Returns: Array of 3 RGB values, each between 0 and 1
Created in NX1847.0.0.

License requirements : None

virtual NXString NXOpen::Diagramming::ReferenceGeometryBuilder::GetExternalFileDefinitionKey ( NXOpen::ExternalFileReferenceAdapter * adapter )

virtual

Gets the file definition to use for external file adapter.

Created in NX1847.0.0.

License requirements : None

Parameters

adapter external file reference object

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Diagramming::ReferenceGeometryBuilder::GetExternalFileReferenceAdapter ( int referenceObjectId )

virtual

Returns the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to return the correct external file adapter.

Returns: external file reference object
Created in NX1847.0.0.

License requirements : None

Parameters

referenceObjectId the unique identifier of the external reference required in case where referencer has multiple external references

Implements NXOpen::IExternalFileReferencer.

void NXOpen::Diagramming::ReferenceGeometryBuilder::RefreshFromView ( bool refresh )

When set will cause a refresh of the geometry from the drawing view during commit.

Created in NX1847.0.0.

License requirements : None

Parameters

refresh true - a refresh will be performed, false - a refresh will not be performed

double NXOpen::Diagramming::ReferenceGeometryBuilder::Scale ( )

Returns the scale
Created in NX1847.0.0.

License requirements : None

void NXOpen::Diagramming::ReferenceGeometryBuilder::SetColor ( const std::vector< double > & color )

Sets the color
Created in NX1847.0.0.

License requirements : None

Parameters

color Array of 3 RGB values, each between 0 and 1

void NXOpen::Diagramming::ReferenceGeometryBuilder::SetDisplayBorder ( bool displayBorder )

Sets the setting that determines whether the border should be displayed or not.

Created in NX1847.0.0.

License requirements : None

Parameters

displayBorder displayborder

virtual void NXOpen::Diagramming::ReferenceGeometryBuilder::SetExternalFileReferenceAdapter	(	int	referenceObjectId,
		NXOpen::ExternalFileReferenceAdapter *	adapter
	)

virtual

Sets the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to set the correct reference.
Created in NX1847.0.0.

License requirements : None

Parameters

referenceObjectId	the unique identifier of the external reference required in case where referencer has multiple external references
adapter	external file reference object

Implements NXOpen::IExternalFileReferencer.

void NXOpen::Diagramming::ReferenceGeometryBuilder::SetScale ( double scale )

Sets the scale
Created in NX1847.0.0.

License requirements : None

Parameters

scale scale

void NXOpen::Diagramming::ReferenceGeometryBuilder::SetTransparency ( int transparency )

Sets the transparency (between 0 and 100)
Created in NX1847.0.0.

License requirements : None

Parameters

transparency transparency

void NXOpen::Diagramming::ReferenceGeometryBuilder::SetView ( const NXString & viewIdentifier )

Sets the view to import from
Created in NX1847.0.0.

License requirements : None

Parameters

viewIdentifier Identifier of the drafting view

void NXOpen::Diagramming::ReferenceGeometryBuilder::SetView ( const char * viewIdentifier )

Sets the view to import from
Created in NX1847.0.0.

License requirements : None

Parameters

viewIdentifier Identifier of the drafting view

int NXOpen::Diagramming::ReferenceGeometryBuilder::Transparency ( )

Returns the transparency (between 0 and 100)
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Diagramming::ReferenceGeometryBuilder::View ( )

Returns the view to import from
Created in NX1847.0.0.

License requirements : None

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

Diagramming_ReferenceGeometryBuilder.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation