Represents a LocationBuilder. More...

Inheritance diagram for NXOpen::Diagramming::LocationBuilder:

Public Member Functions
double	EvaluatedValueX ()
	Returns the evaluated X coordinate value that is the result calculated by the input percentage and offset. More...

double	EvaluatedValueY ()
	Returns the evaluated Y coordinate value that is the result calculated by input percentage and offset. More...

double	InputPercentX ()
	Returns the user input percentage (0.0 to 1.0) of the width of the referenced object. More...

double	InputPercentY ()
	Returns the user input percentage (0.0 to 1.0) of the height of the referenced object. More...

double	InputValueX ()
	Returns the user input X coordinate. More...

double	InputValueY ()
	Returns the user input Y coordinate. More...

NXOpen::Diagramming::SheetElement *	Reference ()
	Returns the sheet element whose coordinate system the coordinate is specified in. More...

void	SetInputPercentX (double inputPercentX)
	Sets the user input percentage (0.0 to 1.0) of the width of the referenced object. More...

void	SetInputPercentY (double inputPercentY)
	Sets the user input percentage (0.0 to 1.0) of the height of the referenced object. More...

void	SetInputValueX (double inputValueX)
	Sets the user input X coordinate. More...

void	SetInputValueY (double inputValueY)
	Sets the user input Y coordinate. More...

void	SetReference (NXOpen::Diagramming::SheetElement *reference)
	Sets the sheet element whose coordinate system the coordinate is specified in. More...

void	SetValueX (double inputPercent, double inputValue)
	Set the x value of the location. More...

void	SetValueY (double inputPercent, double inputValue)
	Set the y value of the location. More...

bool	UpToDate ()
	Returns the up to date flag. More...

Public Member Functions inherited from NXOpen::Diagramming::BaseSubObjectBuilder
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a LocationBuilder.

This is a sub-builder class and cannot be directly instantiated

Created in NX10.0.0.

Member Function Documentation

double NXOpen::Diagramming::LocationBuilder::EvaluatedValueX ( )

Returns the evaluated X coordinate value that is the result calculated by the input percentage and offset.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::LocationBuilder::EvaluatedValueY ( )

Returns the evaluated Y coordinate value that is the result calculated by input percentage and offset.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::LocationBuilder::InputPercentX ( )

Returns the user input percentage (0.0 to 1.0) of the width of the referenced object.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::LocationBuilder::InputPercentY ( )

Returns the user input percentage (0.0 to 1.0) of the height of the referenced object.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::LocationBuilder::InputValueX ( )

Returns the user input X coordinate.

If the location refers to an object, the input X is the offset to the X coordinate of the object; Otherwise, it's the X coordinate value.
Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::LocationBuilder::InputValueY ( )

Returns the user input Y coordinate.

If the location refers to an object, the input Y is the offset to the Y coordinate of the object; Otherwise, it's the Y coordinate value.
Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::SheetElement* NXOpen::Diagramming::LocationBuilder::Reference ( )

Returns the sheet element whose coordinate system the coordinate is specified in.

If this is NULL, the coordinate is in the Sheet's coordinate system.
Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::LocationBuilder::SetInputPercentX ( double inputPercentX )

Sets the user input percentage (0.0 to 1.0) of the width of the referenced object.

Created in NX10.0.0.

License requirements : None

Parameters

inputPercentX inputpercentx

void NXOpen::Diagramming::LocationBuilder::SetInputPercentY ( double inputPercentY )

Sets the user input percentage (0.0 to 1.0) of the height of the referenced object.

Created in NX10.0.0.

License requirements : None

Parameters

inputPercentY inputpercenty

void NXOpen::Diagramming::LocationBuilder::SetInputValueX ( double inputValueX )

Sets the user input X coordinate.

If the location refers to an object, the input X is the offset to the X coordinate of the object; Otherwise, it's the X coordinate value.
Created in NX10.0.0.

License requirements : None

Parameters

inputValueX inputvaluex

void NXOpen::Diagramming::LocationBuilder::SetInputValueY ( double inputValueY )

Sets the user input Y coordinate.

If the location refers to an object, the input Y is the offset to the Y coordinate of the object; Otherwise, it's the Y coordinate value.
Created in NX10.0.0.

License requirements : None

Parameters

inputValueY inputvaluey

void NXOpen::Diagramming::LocationBuilder::SetReference ( NXOpen::Diagramming::SheetElement * reference )

Sets the sheet element whose coordinate system the coordinate is specified in.

If this is NULL, the coordinate is in the Sheet's coordinate system.
Created in NX10.0.0.

License requirements : None

Parameters

reference reference

void NXOpen::Diagramming::LocationBuilder::SetValueX	(	double	inputPercent,
		double	inputValue
	)

Set the x value of the location.

The inputPercent means of the x coordinate value as a percentage of the size of its reference object. The valid value is from 0.0 to 1.0, and 1.0 means 100%. The inputValue means the offset value of the x coordinate from the calculated location by the inputPercent value.
Created in NX10.0.0.

License requirements : None

Parameters

inputPercent	inputpercent
inputValue	inputvalue

void NXOpen::Diagramming::LocationBuilder::SetValueY	(	double	inputPercent,
		double	inputValue
	)

Set the y value of the location.

The inputPercent means of the y coordinate value as a percentage of the size of its reference object. The valid value is from 0.0 to 1.0, and 1.0 means 100%. The inputValue means the offset value of the y coordinate from the calculated location by the inputPercent value.
Created in NX10.0.0.

License requirements : None

Parameters

inputPercent	inputpercent
inputValue	inputvalue

bool NXOpen::Diagramming::LocationBuilder::UpToDate ( )

Returns the up to date flag.

If true, NXOpen::Diagramming::LocationBuilder::EvaluatedValueX and NXOpen::Diagramming::LocationBuilder::EvaluatedValueY of NXOpen::Diagramming::LocationBuilder may be used; Otherwise it must be evaluated.
Created in NX10.0.0.

License requirements : None

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

Diagramming_LocationBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation