NXOpen C++ Reference Guide
|
The unit cell editor allows an application to create, store and edit a lattice unit cell. More...
Public Member Functions | |
int | CellCountX () |
Returns the number of unit cells to display along X axis when show pattern is ON Created in NX1847.0.0. More... | |
int | CellCountY () |
Returns the number of unit cells to display along Y axis when show pattern is ON Created in NX1847.0.0. More... | |
int | CellCountZ () |
Returns the number of unit cells to display along Z axis when show pattern is ON Created in NX1847.0.0. More... | |
void | CreateSnapHandles () |
Journaling for the Creation of Snap Handles Created in NX1847.0.0. More... | |
void | CreateWorkingCube () |
Create the working cube to view the space where the unit cell must be defined. More... | |
NXString | FileBrowser () |
Returns the unit cell file name to open or save Created in NX1847.0.0. More... | |
bool | KeepRods () |
Returns an option to keep all the curves in the part when opening a unit cell file Created in NX1847.0.0. More... | |
int | Open (NXOpen::Section *section) |
Open an existing unit cell file Created in NX1847.0.0. More... | |
double | RodDiameter () |
Returns the unit cell rod diameter Created in NX1847.0.0. More... | |
NXOpen::GeometricUtilities::RodItemListBuilder * | RodItemList () |
Returns a rod item list Created in NX1847.0.0. More... | |
void | Save () |
Save the unit cell file using the file name registered in this builder Created in NX1847.0.0. More... | |
void | SetCellCountX (int cellCountX) |
Sets the number of unit cells to display along X axis when show pattern is ON Created in NX1847.0.0. More... | |
void | SetCellCountY (int cellCountY) |
Sets the number of unit cells to display along Y axis when show pattern is ON Created in NX1847.0.0. More... | |
void | SetCellCountZ (int cellCountZ) |
Sets the number of unit cells to display along Z axis when show pattern is ON Created in NX1847.0.0. More... | |
void | SetFileBrowser (const NXString &filename) |
Sets the unit cell file name to open or save Created in NX1847.0.0. More... | |
void | SetFileBrowser (const char *filename) |
Sets the unit cell file name to open or save Created in NX1847.0.0. More... | |
void | SetKeepRods (bool keepRods) |
Sets an option to keep all the curves in the part when opening a unit cell file Created in NX1847.0.0. More... | |
void | SetRodDiameter (double rodDiameter) |
Sets the unit cell rod diameter Created in NX1847.0.0. More... | |
void | SetShowPattern (bool showPattern) |
Sets an option to show the unit cell pattern Created in NX1847.0.0. More... | |
bool | ShowPattern () |
Returns an option to show the unit cell pattern Created in NX1847.0.0. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
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::NXObject * | GetObject () |
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... | |
The unit cell editor allows an application to create, store and edit a lattice unit cell.
The application can open an existing unit cell file and the rods will be available for deselection. The application can select curves and edges in the work part to be included in a new unit cell file. Note that the method Builder::Commit will simply call Save .
To create a new instance of this class, use NXOpen::Features::LatticeFeatureCollection::CreateUnitCellEditorBuilder
Created in NX1847.0.0.
int NXOpen::Features::UnitCellEditorBuilder::CellCountX | ( | ) |
Returns the number of unit cells to display along X axis when show pattern is ON
Created in NX1847.0.0.
License requirements : None
int NXOpen::Features::UnitCellEditorBuilder::CellCountY | ( | ) |
Returns the number of unit cells to display along Y axis when show pattern is ON
Created in NX1847.0.0.
License requirements : None
int NXOpen::Features::UnitCellEditorBuilder::CellCountZ | ( | ) |
Returns the number of unit cells to display along Z axis when show pattern is ON
Created in NX1847.0.0.
License requirements : None
void NXOpen::Features::UnitCellEditorBuilder::CreateSnapHandles | ( | ) |
Journaling for the Creation of Snap Handles
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
void NXOpen::Features::UnitCellEditorBuilder::CreateWorkingCube | ( | ) |
Create the working cube to view the space where the unit cell must be defined.
The edges and the faces of the working cube can be used to define the rod start and end locations.
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
NXString NXOpen::Features::UnitCellEditorBuilder::FileBrowser | ( | ) |
Returns the unit cell file name to open or save
Created in NX1847.0.0.
License requirements : None
bool NXOpen::Features::UnitCellEditorBuilder::KeepRods | ( | ) |
Returns an option to keep all the curves in the part when opening a unit cell file
Created in NX1847.0.0.
License requirements : None
int NXOpen::Features::UnitCellEditorBuilder::Open | ( | NXOpen::Section * | section | ) |
Open an existing unit cell file
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
section | section |
double NXOpen::Features::UnitCellEditorBuilder::RodDiameter | ( | ) |
Returns the unit cell rod diameter
Created in NX1847.0.0.
License requirements : None
NXOpen::GeometricUtilities::RodItemListBuilder* NXOpen::Features::UnitCellEditorBuilder::RodItemList | ( | ) |
Returns a rod item list
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
void NXOpen::Features::UnitCellEditorBuilder::Save | ( | ) |
Save the unit cell file using the file name registered in this builder
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
void NXOpen::Features::UnitCellEditorBuilder::SetCellCountX | ( | int | cellCountX | ) |
Sets the number of unit cells to display along X axis when show pattern is ON
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
cellCountX | cellcountx |
void NXOpen::Features::UnitCellEditorBuilder::SetCellCountY | ( | int | cellCountY | ) |
Sets the number of unit cells to display along Y axis when show pattern is ON
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
cellCountY | cellcounty |
void NXOpen::Features::UnitCellEditorBuilder::SetCellCountZ | ( | int | cellCountZ | ) |
Sets the number of unit cells to display along Z axis when show pattern is ON
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
cellCountZ | cellcountz |
void NXOpen::Features::UnitCellEditorBuilder::SetFileBrowser | ( | const NXString & | filename | ) |
Sets the unit cell file name to open or save
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
filename | filename |
void NXOpen::Features::UnitCellEditorBuilder::SetFileBrowser | ( | const char * | filename | ) |
Sets the unit cell file name to open or save
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
filename | filename |
void NXOpen::Features::UnitCellEditorBuilder::SetKeepRods | ( | bool | keepRods | ) |
Sets an option to keep all the curves in the part when opening a unit cell file
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
keepRods | keeprods |
void NXOpen::Features::UnitCellEditorBuilder::SetRodDiameter | ( | double | rodDiameter | ) |
Sets the unit cell rod diameter
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
rodDiameter | roddiameter |
void NXOpen::Features::UnitCellEditorBuilder::SetShowPattern | ( | bool | showPattern | ) |
Sets an option to show the unit cell pattern
Created in NX1847.0.0.
License requirements : nx_lattice_base (" NX Lattice Base")
showPattern | showpattern |
bool NXOpen::Features::UnitCellEditorBuilder::ShowPattern | ( | ) |
Returns an option to show the unit cell pattern
Created in NX1847.0.0.
License requirements : None