NX Open C++ Reference Guide
|
Represents a collection of layouts. More...
Classes | |
class | iterator |
Iterator for accessing the contents of the collection. More... | |
Public Member Functions | |
iterator | begin () |
Returns an iterator addressing the first element. More... | |
void | ChangeLayout (NXOpen::Layout *layout) |
Sets the given layout as current layout Created in NX6.0.0. More... | |
void | ChangeLayoutWithOptions (NXOpen::Layout *layout, bool removeOldLayoutCache, bool ignoreNewLayoutCache) |
Sets the given layout as current layout and optionally removes the old and/or new layout caches Created in NX11.0.0. More... | |
NXOpen::Layout * | Create (const NXString &name, NXOpen::LayoutDefinition *layoutArrangement, bool fitAllViews) |
Creates a layout using an NXOpen::LayoutDefinition . More... | |
NXOpen::Layout * | Create (const char *name, NXOpen::LayoutDefinition *layoutArrangement, bool fitAllViews) |
Creates a layout using an NXOpen::LayoutDefinition . More... | |
void | CreateSplitScreenLayoutAndNamedViews (const NXString &leftViewName, const NXString &rightViewname, NXOpen::Layout **layout, NXOpen::View **leftView, NXOpen::View **rightView) |
This method creates a layout with two modeling views. More... | |
void | CreateSplitScreenLayoutAndNamedViews (const char *leftViewName, const char *rightViewname, NXOpen::Layout **layout, NXOpen::View **leftView, NXOpen::View **rightView) |
This method creates a layout with two modeling views. More... | |
NXOpen::Layout * | Current () |
Returns the current layout of the part. More... | |
void | DestroySplitScreenLayoutAndNamedViews (NXOpen::Layout *layout) |
This method destroys the split screen layout along with the views that are there in it Created in NX6.0.0. More... | |
iterator | end () |
Returns an iterator addressing one past the last element. More... | |
NXOpen::Layout * | FindObject (const NXString &journalIdentifier) |
Finds the NXOpen::Layout with the given identifier as recorded in a journal. More... | |
NXOpen::Layout * | FindObject (const char *journalIdentifier) |
Finds the NXOpen::Layout with the given identifier as recorded in a journal. More... | |
void | NewLayoutDefinition (NXOpen::LayoutDefinition::ArrangementType arrangement, NXOpen::LayoutDefinition **layoutArrangement) |
Constructs a NXOpen::LayoutDefinition object to be used to create a layout. More... | |
void | RenameViewsInSplitScreenLayout (NXOpen::Layout *layout, const NXString &leftViewName, const NXString &rightViewName) |
Using given names renames the views in split screen layout. More... | |
void | RenameViewsInSplitScreenLayout (NXOpen::Layout *layout, const char *leftViewName, const char *rightViewName) |
Using given names renames the views in split screen layout. More... | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents a collection of layouts.
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX3.0.0.
iterator NXOpen::LayoutCollection::begin | ( | ) |
Returns an iterator addressing the first element.
void NXOpen::LayoutCollection::ChangeLayout | ( | NXOpen::Layout * | layout | ) |
Sets the given layout as current layout
Created in NX6.0.0.
License requirements : None
layout | Layout |
void NXOpen::LayoutCollection::ChangeLayoutWithOptions | ( | NXOpen::Layout * | layout, |
bool | removeOldLayoutCache, | ||
bool | ignoreNewLayoutCache | ||
) |
Sets the given layout as current layout and optionally removes the old and/or new layout caches
Created in NX11.0.0.
License requirements : None
layout | Layout |
removeOldLayoutCache | Flag to indicate if the current layout's cache should be removed |
ignoreNewLayoutCache | Flag to indicate if the new layout's cache should be used or removed |
NXOpen::Layout* NXOpen::LayoutCollection::Create | ( | const NXString & | name, |
NXOpen::LayoutDefinition * | layoutArrangement, | ||
bool | fitAllViews | ||
) |
Creates a layout using an NXOpen::LayoutDefinition .
name | Name of layout |
layoutArrangement | Arrangement and view location information |
fitAllViews | Flag that indicates for the system to perform a fit before displaying the view. Otherwise the system displays the view at the scale at which it was last saved. |
NXOpen::Layout* NXOpen::LayoutCollection::Create | ( | const char * | name, |
NXOpen::LayoutDefinition * | layoutArrangement, | ||
bool | fitAllViews | ||
) |
Creates a layout using an NXOpen::LayoutDefinition .
name | Name of layout |
layoutArrangement | Arrangement and view location information |
fitAllViews | Flag that indicates for the system to perform a fit before displaying the view. Otherwise the system displays the view at the scale at which it was last saved. |
void NXOpen::LayoutCollection::CreateSplitScreenLayoutAndNamedViews | ( | const NXString & | leftViewName, |
const NXString & | rightViewname, | ||
NXOpen::Layout ** | layout, | ||
NXOpen::View ** | leftView, | ||
NXOpen::View ** | rightView | ||
) |
This method creates a layout with two modeling views.
The views are created with names given. Layout and view tags are returned
Created in NX6.0.0.
License requirements : None
leftViewName | name for the left view |
rightViewname | name for the right view |
layout | Layout |
leftView | View |
rightView | View |
void NXOpen::LayoutCollection::CreateSplitScreenLayoutAndNamedViews | ( | const char * | leftViewName, |
const char * | rightViewname, | ||
NXOpen::Layout ** | layout, | ||
NXOpen::View ** | leftView, | ||
NXOpen::View ** | rightView | ||
) |
This method creates a layout with two modeling views.
The views are created with names given. Layout and view tags are returned
Created in NX6.0.0.
License requirements : None
leftViewName | name for the left view |
rightViewname | name for the right view |
layout | Layout |
leftView | View |
rightView | View |
NXOpen::Layout* NXOpen::LayoutCollection::Current | ( | ) |
Returns the current layout of the part.
When in the drafting application and a drawing sheet is not displayed, this will return a layout that has limited operations that can be performed on it.
Created in NX3.0.0.
License requirements : None
void NXOpen::LayoutCollection::DestroySplitScreenLayoutAndNamedViews | ( | NXOpen::Layout * | layout | ) |
This method destroys the split screen layout along with the views that are there in it
Created in NX6.0.0.
License requirements : None
layout | Layout |
iterator NXOpen::LayoutCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
NXOpen::Layout* NXOpen::LayoutCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the NXOpen::Layout with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier | Identifier to be found |
NXOpen::Layout* NXOpen::LayoutCollection::FindObject | ( | const char * | journalIdentifier | ) |
Finds the NXOpen::Layout with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier | Identifier to be found |
void NXOpen::LayoutCollection::NewLayoutDefinition | ( | NXOpen::LayoutDefinition::ArrangementType | arrangement, |
NXOpen::LayoutDefinition ** | layoutArrangement | ||
) |
Constructs a NXOpen::LayoutDefinition object to be used to create a layout.
If a layout is not created using the created definition object, the client is responsible for deleting it.
Created in NX3.0.0.
License requirements : None
arrangement | Arrangement type |
layoutArrangement | Layout arrangement used to create a layout |
void NXOpen::LayoutCollection::RenameViewsInSplitScreenLayout | ( | NXOpen::Layout * | layout, |
const NXString & | leftViewName, | ||
const NXString & | rightViewName | ||
) |
Using given names renames the views in split screen layout.
Created in NX6.0.0.
License requirements : None
layout | Layout |
leftViewName | name for the left view |
rightViewName | name for the right view |
void NXOpen::LayoutCollection::RenameViewsInSplitScreenLayout | ( | NXOpen::Layout * | layout, |
const char * | leftViewName, | ||
const char * | rightViewName | ||
) |
Using given names renames the views in split screen layout.
Created in NX6.0.0.
License requirements : None
layout | Layout |
leftViewName | name for the left view |
rightViewName | name for the right view |
tag_t NXOpen::LayoutCollection::Tag | ( | ) | const |
Returns the tag of this object.