LocationBuilder Class¶
-
class
NXOpen.Diagramming.
LocationBuilder
¶ Bases:
NXOpen.Diagramming.BaseSubObjectBuilder
Represents a LocationBuilder.
This is a sub-builder class and cannot be directly instantiated
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
EvaluatedValueX | Returns the evaluated X coordinate value that is the result calculated by the input percentage and offset. |
EvaluatedValueY | Returns the evaluated Y coordinate value that is the result calculated by input percentage and offset. |
InputPercentX | Returns or sets the user input percentage (0. |
InputPercentY | Returns or sets the user input percentage (0. |
InputValueX | Returns or sets the user input X coordinate. |
InputValueY | Returns or sets the user input Y coordinate. |
Reference | Returns or sets the sheet element whose coordinate system the coordinate is specified in. |
Tag | Returns the Tag for this object. |
UpToDate | Returns the up to date flag. |
Methods¶
Method | Description |
---|---|
SetValueX | Set the x value of the location. |
SetValueY | Set the y value of the location. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
EvaluatedValueX¶
-
LocationBuilder.
EvaluatedValueX
¶ Returns the evaluated X coordinate value that is the result calculated by the input percentage and offset.
-------------------------------------
Getter Method
Signature
EvaluatedValueX()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
EvaluatedValueY¶
-
LocationBuilder.
EvaluatedValueY
¶ Returns the evaluated Y coordinate value that is the result calculated by input percentage and offset.
-------------------------------------
Getter Method
Signature
EvaluatedValueY()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
InputPercentX¶
-
LocationBuilder.
InputPercentX
¶ Returns or sets the user input percentage (0.
0 to 1.0) of the width of the referenced object.
-------------------------------------
Getter Method
Signature
InputPercentX()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InputPercentX(inputPercentX)
Parameters: inputPercentX (float) – New in version NX10.0.0.
License requirements: None.
InputPercentY¶
-
LocationBuilder.
InputPercentY
¶ Returns or sets the user input percentage (0.
0 to 1.0) of the height of the referenced object.
-------------------------------------
Getter Method
Signature
InputPercentY()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InputPercentY(inputPercentY)
Parameters: inputPercentY (float) – New in version NX10.0.0.
License requirements: None.
InputValueX¶
-
LocationBuilder.
InputValueX
¶ Returns or 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.
-------------------------------------
Getter Method
Signature
InputValueX()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InputValueX(inputValueX)
Parameters: inputValueX (float) – New in version NX10.0.0.
License requirements: None.
InputValueY¶
-
LocationBuilder.
InputValueY
¶ Returns or 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.
-------------------------------------
Getter Method
Signature
InputValueY()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InputValueY(inputValueY)
Parameters: inputValueY (float) – New in version NX10.0.0.
License requirements: None.
Reference¶
-
LocationBuilder.
Reference
¶ Returns or sets the sheet element whose coordinate system the coordinate is specified in.
If this is None, the coordinate is in the Sheet’s coordinate system.
-------------------------------------
Getter Method
Signature
Reference()
Returns: Return type: NXOpen.Diagramming.SheetElement
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Reference(reference)
Parameters: reference ( NXOpen.Diagramming.SheetElement
) –New in version NX10.0.0.
License requirements: None.
UpToDate¶
-
LocationBuilder.
UpToDate
¶ Returns the up to date flag.
If true,
NXOpen.Diagramming.LocationBuilder.EvaluatedValueX()
andNXOpen.Diagramming.LocationBuilder.EvaluatedValueY()
ofNXOpen.Diagramming.LocationBuilder
may be used; Otherwise it must be evaluated.-------------------------------------
Getter Method
Signature
UpToDate()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
Method Detail¶
SetValueX¶
-
LocationBuilder.
SetValueX
¶ 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.
Signature
SetValueX(inputPercent, inputValue)
Parameters: - inputPercent (float) –
- inputValue (float) –
New in version NX10.0.0.
License requirements: None.
SetValueY¶
-
LocationBuilder.
SetValueY
¶ 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.
Signature
SetValueY(inputPercent, inputValue)
Parameters: - inputPercent (float) –
- inputValue (float) –
New in version NX10.0.0.
License requirements: None.
Validate¶
-
LocationBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.