SpatialMapBuilder Class¶
-
class
NXOpen.Fields.
SpatialMapBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Fields.SpatialMap
builderUsed to create and or edit a
NXOpen.Fields.SpatialMap
.To create a new instance of this class, use
NXOpen.Fields.FieldManager.CreateSpatialMapBuilder()
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
BoundedObjects | Returns the bounded objects |
BoundingBoxMap | Returns or sets the bounding box map |
ConstUObjects | Returns the list of NXOpen.Fields.PathObjects objects that define sections of constant u |
ConstVObjects | Returns the list of NXOpen.Fields.PathObjects objects that define sections of constant v |
ConstantUObjects | Returns the const uobjects |
ConstantVObjects | Returns the const vobjects |
CoordSystem | Returns or sets the csys |
FaceTolerance | Returns the face tolerance for 3D degenerate surface maps |
LatticePath | Returns the lattice path objects |
MapSubtype | Returns or sets the map subtype |
MapSubtypeMapping | Returns or sets the subtype mapping |
MapType | Returns or sets the map type |
MappingFaces | Returns the faces to be used as mapping objects |
OppositeCorner | Returns or sets the opposite corner |
Origin | Returns or sets the origin |
ParametricPlaneMap | Returns or sets the parametric plane map |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AutoTolerance | The method to set the face tolerance to a default value based on the current state of the field |
Commit | Commits any edits that have been applied to the builder. |
CreateLatticeMap | Create a lattice spatial map from the input datapoints array. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
BoundedObjects¶
-
SpatialMapBuilder.
BoundedObjects
¶ Returns the bounded objects
-------------------------------------
Getter Method
Signature
BoundedObjects
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX6.0.0.
License requirements: None.
BoundingBoxMap¶
-
SpatialMapBuilder.
BoundingBoxMap
¶ Returns or sets the bounding box map
-------------------------------------
Getter Method
Signature
BoundingBoxMap
Returns: Return type: NXOpen.Fields.SpatialMapBoundingBoxMapEnum
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BoundingBoxMap
Parameters: boundBoxMap ( NXOpen.Fields.SpatialMapBoundingBoxMapEnum
) –New in version NX6.0.0.
License requirements: None.
ConstUObjects¶
-
SpatialMapBuilder.
ConstUObjects
¶ Returns the list of
NXOpen.Fields.PathObjects
objects that define sections of constant u-------------------------------------
Getter Method
Signature
ConstUObjects
Returns: Return type: NXOpen.Fields.PathObjectsList
New in version NX6.0.1.
License requirements: None.
ConstVObjects¶
-
SpatialMapBuilder.
ConstVObjects
¶ Returns the list of
NXOpen.Fields.PathObjects
objects that define sections of constant v-------------------------------------
Getter Method
Signature
ConstVObjects
Returns: Return type: NXOpen.Fields.PathObjectsList
New in version NX6.0.1.
License requirements: None.
ConstantUObjects¶
-
SpatialMapBuilder.
ConstantUObjects
¶ Returns the const uobjects
-------------------------------------
Getter Method
Signature
ConstantUObjects
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX6.0.0.
Deprecated since version NX6.0.1: Use
NXOpen.Fields.SpatialMapBuilder.ConstUObjects()
instead.License requirements: None.
ConstantVObjects¶
-
SpatialMapBuilder.
ConstantVObjects
¶ Returns the const vobjects
-------------------------------------
Getter Method
Signature
ConstantVObjects
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX6.0.0.
Deprecated since version NX6.0.1: Use
NXOpen.Fields.SpatialMapBuilder.ConstVObjects()
instead.License requirements: None.
CoordSystem¶
-
SpatialMapBuilder.
CoordSystem
¶ Returns or sets the csys
-------------------------------------
Getter Method
Signature
CoordSystem
Returns: Return type: NXOpen.CoordinateSystem
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoordSystem
Parameters: csys ( NXOpen.CoordinateSystem
) –New in version NX6.0.0.
License requirements: None.
FaceTolerance¶
-
SpatialMapBuilder.
FaceTolerance
¶ Returns the face tolerance for 3D degenerate surface maps
-------------------------------------
Getter Method
Signature
FaceTolerance
Returns: Return type: NXOpen.Expression
New in version NX8.5.0.
License requirements: None.
LatticePath¶
-
SpatialMapBuilder.
LatticePath
¶ Returns the lattice path objects
-------------------------------------
Getter Method
Signature
LatticePath
Returns: Return type: NXOpen.Fields.PathObjects
New in version NX6.0.1.
License requirements: None.
MapSubtype¶
-
SpatialMapBuilder.
MapSubtype
¶ Returns or sets the map subtype
-------------------------------------
Getter Method
Signature
MapSubtype
Returns: Return type: NXOpen.Fields.SpatialMapSubtypeEnum
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MapSubtype
Parameters: mapSubType ( NXOpen.Fields.SpatialMapSubtypeEnum
) –New in version NX8.5.0.
License requirements: None.
MapSubtypeMapping¶
-
SpatialMapBuilder.
MapSubtypeMapping
¶ Returns or sets the subtype mapping
-------------------------------------
Getter Method
Signature
MapSubtypeMapping
Returns: Return type: NXOpen.Fields.SpatialMapSubtypeMappingEnum
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MapSubtypeMapping
Parameters: mapSubTypeMapping ( NXOpen.Fields.SpatialMapSubtypeMappingEnum
) –New in version NX8.5.0.
License requirements: None.
MapType¶
-
SpatialMapBuilder.
MapType
¶ Returns or sets the map type
-------------------------------------
Getter Method
Signature
MapType
Returns: Return type: NXOpen.Fields.SpatialMapTypeEnum
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MapType
Parameters: mapType ( NXOpen.Fields.SpatialMapTypeEnum
) –New in version NX6.0.0.
License requirements: None.
MappingFaces¶
-
SpatialMapBuilder.
MappingFaces
¶ Returns the faces to be used as mapping objects
-------------------------------------
Getter Method
Signature
MappingFaces
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX8.5.0.
License requirements: None.
OppositeCorner¶
-
SpatialMapBuilder.
OppositeCorner
¶ Returns or sets the opposite corner
-------------------------------------
Getter Method
Signature
OppositeCorner
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OppositeCorner
Parameters: oppositeCorner ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: None.
Origin¶
-
SpatialMapBuilder.
Origin
¶ Returns or sets the origin
-------------------------------------
Getter Method
Signature
Origin
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Origin
Parameters: origin ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: None.
ParametricPlaneMap¶
-
SpatialMapBuilder.
ParametricPlaneMap
¶ Returns or sets the parametric plane map
-------------------------------------
Getter Method
Signature
ParametricPlaneMap
Returns: Return type: NXOpen.Fields.SpatialMapParametricPlaneMapEnum
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParametricPlaneMap
Parameters: parmPlaneMap ( NXOpen.Fields.SpatialMapParametricPlaneMapEnum
) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
AutoTolerance¶
-
SpatialMapBuilder.
AutoTolerance
¶ The method to set the face tolerance to a default value based on the current state of the field
Signature
AutoTolerance()
New in version NX8.5.0.
License requirements: None.
CreateLatticeMap¶
-
SpatialMapBuilder.
CreateLatticeMap
¶ Create a lattice spatial map from the input datapoints array.
The number of columns in the datapoints array is specified by numOfColumns, and should include the total of all independent and dependent columns. Note that the number of dependent columns can be zero. The independent domain must be x, y, z, xy, xz, yz or xyz and the number of columns must be greater than or equal to the count of the independent variables.
The number of rows of data in the datapoints array is calculated by dividing the number of data points by the number of columns.
If number of lattice columns is 1, then a parametric line based map will be created.
Otherwise the lattice will be a M x N u-v grid, where M is the number of lattice columns and N is calculated based on the number of rows in the data points array divded by the number of lattice columns
Signature
CreateLatticeMap(numOfLatticeColumn, numOfColumns, indepVarArray, datapoint)
Parameters: - numOfLatticeColumn (int) –
- numOfColumns (int) –
- indepVarArray (list of
NXOpen.Fields.FieldVariable
) – - datapoint (list of float) –
Returns: a tuple
Return type: A tuple consisting of (latticeMap, parameterizedDatapoints). latticeMap is a
NXOpen.Fields.SpatialMap
. parameterizedDatapoints is a list of float.New in version NX12.0.0.
License requirements: None.
Validate¶
-
SpatialMapBuilder.
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.