NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Fields::SpatialMapBuilder Class Reference

Represents a NXOpen::Fields::SpatialMap builder. More...

Inheritance diagram for NXOpen::Fields::SpatialMapBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void AutoTolerance ()
 The method to set the face tolerance to a default value based on the current state of the field
Created in NX8.5.0. More...
 
NXOpen::SelectNXObjectListBoundedObjects ()
 Returns the bounded objects
Created in NX6.0.0. More...
 
NXOpen::Fields::SpatialMap::BoundingBoxMapEnum BoundingBoxMap ()
 Returns the bounding box map
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectListConstantUObjects ()
 Returns the const uobjects
More...
 
NXOpen::SelectNXObjectListConstantVObjects ()
 Returns the const vobjects
More...
 
NXOpen::Fields::PathObjectsListConstUObjects ()
 Returns the list of NXOpen::Fields::PathObjects objects that define sections of constant u
Created in NX6.0.1. More...
 
NXOpen::Fields::PathObjectsListConstVObjects ()
 Returns the list of NXOpen::Fields::PathObjects objects that define sections of constant v
Created in NX6.0.1. More...
 
NXOpen::CoordinateSystemCoordSystem ()
 Returns the csys
Created in NX6.0.0. More...
 
NXOpen::Fields::SpatialMapCreateLatticeMap (int numOfLatticeColumn, int numOfColumns, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< double > &datapoint, std::vector< double > &parameterizedDatapoints)
 Create a lattice spatial map from the input datapoints array. More...
 
NXOpen::ExpressionFaceTolerance ()
 Returns the face tolerance for 3D degenerate surface maps
Created in NX8.5.0. More...
 
NXOpen::Fields::PathObjectsLatticePath ()
 Returns the lattice path objects
Created in NX6.0.1. More...
 
NXOpen::SelectNXObjectListMappingFaces ()
 Returns the faces to be used as mapping objects
Created in NX8.5.0. More...
 
NXOpen::Fields::SpatialMap::SubtypeEnum MapSubtype ()
 Returns the map subtype
Created in NX8.5.0. More...
 
NXOpen::Fields::SpatialMap::SubtypeMappingEnum MapSubtypeMapping ()
 Returns the subtype mapping
Created in NX8.5.0. More...
 
NXOpen::Fields::SpatialMap::TypeEnum MapType ()
 Returns the map type
Created in NX6.0.0. More...
 
NXOpen::PointOppositeCorner ()
 Returns the opposite corner
Created in NX6.0.0. More...
 
NXOpen::PointOrigin ()
 Returns the origin
Created in NX6.0.0. More...
 
NXOpen::Fields::SpatialMap::ParametricPlaneMapEnum ParametricPlaneMap ()
 Returns the parametric plane map
Created in NX6.0.0. More...
 
void SetBoundingBoxMap (NXOpen::Fields::SpatialMap::BoundingBoxMapEnum boundBoxMap)
 Sets the bounding box map
Created in NX6.0.0. More...
 
void SetCoordSystem (NXOpen::CoordinateSystem *csys)
 Sets the csys
Created in NX6.0.0. More...
 
void SetMapSubtype (NXOpen::Fields::SpatialMap::SubtypeEnum mapSubType)
 Sets the map subtype
Created in NX8.5.0. More...
 
void SetMapSubtypeMapping (NXOpen::Fields::SpatialMap::SubtypeMappingEnum mapSubTypeMapping)
 Sets the subtype mapping
Created in NX8.5.0. More...
 
void SetMapType (NXOpen::Fields::SpatialMap::TypeEnum mapType)
 Sets the map type
Created in NX6.0.0. More...
 
void SetOppositeCorner (NXOpen::Point *oppositeCorner)
 Sets the opposite corner
Created in NX6.0.0. More...
 
void SetOrigin (NXOpen::Point *origin)
 Sets the origin
Created in NX6.0.0. More...
 
void SetParametricPlaneMap (NXOpen::Fields::SpatialMap::ParametricPlaneMapEnum parmPlaneMap)
 Sets the parametric plane map
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
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 NXOpen::Fields::SpatialMap builder.


Used to create and or edit a NXOpen::Fields::SpatialMap .

To create a new instance of this class, use NXOpen::Fields::FieldManager::CreateSpatialMapBuilder

Created in NX6.0.0.

Member Function Documentation

void NXOpen::Fields::SpatialMapBuilder::AutoTolerance ( )

The method to set the face tolerance to a default value based on the current state of the field
Created in NX8.5.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Fields::SpatialMapBuilder::BoundedObjects ( )

Returns the bounded objects
Created in NX6.0.0.



License requirements : None

NXOpen::Fields::SpatialMap::BoundingBoxMapEnum NXOpen::Fields::SpatialMapBuilder::BoundingBoxMap ( )

Returns the bounding box map
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Fields::SpatialMapBuilder::ConstantUObjects ( )

Returns the const uobjects

Deprecated:
Deprecated in NX6.0.1.

Use NXOpen::Fields::SpatialMapBuilder::ConstUObjects instead.


Created in NX6.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Fields::SpatialMapBuilder::ConstantVObjects ( )

Returns the const vobjects

Deprecated:
Deprecated in NX6.0.1.

Use NXOpen::Fields::SpatialMapBuilder::ConstVObjects instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Fields::PathObjectsList* NXOpen::Fields::SpatialMapBuilder::ConstUObjects ( )

Returns the list of NXOpen::Fields::PathObjects objects that define sections of constant u
Created in NX6.0.1.



License requirements : None

NXOpen::Fields::PathObjectsList* NXOpen::Fields::SpatialMapBuilder::ConstVObjects ( )

Returns the list of NXOpen::Fields::PathObjects objects that define sections of constant v
Created in NX6.0.1.



License requirements : None

NXOpen::CoordinateSystem* NXOpen::Fields::SpatialMapBuilder::CoordSystem ( )

Returns the csys
Created in NX6.0.0.



License requirements : None

NXOpen::Fields::SpatialMap* NXOpen::Fields::SpatialMapBuilder::CreateLatticeMap ( int  numOfLatticeColumn,
int  numOfColumns,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray,
const std::vector< double > &  datapoint,
std::vector< double > &  parameterizedDatapoints 
)

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

Returns

Created in NX12.0.0.

License requirements : None
Parameters
numOfLatticeColumnnumoflatticecolumn
numOfColumnsnumofcolumns
indepVarArrayindep var array
datapointdatapoint
parameterizedDatapointsparameterizeddatapoints
NXOpen::Expression* NXOpen::Fields::SpatialMapBuilder::FaceTolerance ( )

Returns the face tolerance for 3D degenerate surface maps
Created in NX8.5.0.



License requirements : None

NXOpen::Fields::PathObjects* NXOpen::Fields::SpatialMapBuilder::LatticePath ( )

Returns the lattice path objects
Created in NX6.0.1.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Fields::SpatialMapBuilder::MappingFaces ( )

Returns the faces to be used as mapping objects
Created in NX8.5.0.



License requirements : None

NXOpen::Fields::SpatialMap::SubtypeEnum NXOpen::Fields::SpatialMapBuilder::MapSubtype ( )

Returns the map subtype
Created in NX8.5.0.



License requirements : None

NXOpen::Fields::SpatialMap::SubtypeMappingEnum NXOpen::Fields::SpatialMapBuilder::MapSubtypeMapping ( )

Returns the subtype mapping
Created in NX8.5.0.



License requirements : None

NXOpen::Fields::SpatialMap::TypeEnum NXOpen::Fields::SpatialMapBuilder::MapType ( )

Returns the map type
Created in NX6.0.0.



License requirements : None

NXOpen::Point* NXOpen::Fields::SpatialMapBuilder::OppositeCorner ( )

Returns the opposite corner
Created in NX6.0.0.



License requirements : None

NXOpen::Point* NXOpen::Fields::SpatialMapBuilder::Origin ( )

Returns the origin
Created in NX6.0.0.



License requirements : None

NXOpen::Fields::SpatialMap::ParametricPlaneMapEnum NXOpen::Fields::SpatialMapBuilder::ParametricPlaneMap ( )

Returns the parametric plane map
Created in NX6.0.0.



License requirements : None

void NXOpen::Fields::SpatialMapBuilder::SetBoundingBoxMap ( NXOpen::Fields::SpatialMap::BoundingBoxMapEnum  boundBoxMap)

Sets the bounding box map
Created in NX6.0.0.



License requirements : None

Parameters
boundBoxMapboundboxmap
void NXOpen::Fields::SpatialMapBuilder::SetCoordSystem ( NXOpen::CoordinateSystem csys)

Sets the csys
Created in NX6.0.0.



License requirements : None

Parameters
csyscsys
void NXOpen::Fields::SpatialMapBuilder::SetMapSubtype ( NXOpen::Fields::SpatialMap::SubtypeEnum  mapSubType)

Sets the map subtype
Created in NX8.5.0.



License requirements : None

Parameters
mapSubTypemapsubtype
void NXOpen::Fields::SpatialMapBuilder::SetMapSubtypeMapping ( NXOpen::Fields::SpatialMap::SubtypeMappingEnum  mapSubTypeMapping)

Sets the subtype mapping
Created in NX8.5.0.



License requirements : None

Parameters
mapSubTypeMappingmapsubtypemapping
void NXOpen::Fields::SpatialMapBuilder::SetMapType ( NXOpen::Fields::SpatialMap::TypeEnum  mapType)

Sets the map type
Created in NX6.0.0.



License requirements : None

Parameters
mapTypemaptype
void NXOpen::Fields::SpatialMapBuilder::SetOppositeCorner ( NXOpen::Point oppositeCorner)

Sets the opposite corner
Created in NX6.0.0.



License requirements : None

Parameters
oppositeCorneroppositecorner
void NXOpen::Fields::SpatialMapBuilder::SetOrigin ( NXOpen::Point origin)

Sets the origin
Created in NX6.0.0.



License requirements : None

Parameters
originorigin
void NXOpen::Fields::SpatialMapBuilder::SetParametricPlaneMap ( NXOpen::Fields::SpatialMap::ParametricPlaneMapEnum  parmPlaneMap)

Sets the parametric plane map
Created in NX6.0.0.



License requirements : None

Parameters
parmPlaneMapparmplanemap

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.