Represents a collection decal material texture
This class is restricted to being called from a program running during an Interactive NX session.
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... | |
| NXOpen::Display::DecalBuilder * | CreateDecalBuilder (NXOpen::TaggedObject *decal) |
| Creates a NXOpen::Display::DecalBuilder object if decal is NULL. More... | |
| NXOpen::Display::DecalBuilder * | CreateDecalBuilderFull (NXOpen::TaggedObject *decal) |
| Creates a NXOpen::Display::DecalBuilder object with image referenced object if decal is NULL. More... | |
| iterator | end () |
| Returns an iterator addressing one past the last element. More... | |
| NXOpen::Decal * | FindDecalObject (const NXString &journalIdentifier) |
| Finds the NXOpen::Decal with the given identifier as recorded in a journal. More... | |
| NXOpen::Decal * | FindDecalObject (const char *journalIdentifier) |
| Finds the NXOpen::Decal with the given identifier as recorded in a journal. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents a collection decal material texture
This class is restricted to being called from a program running during an Interactive NX session.
If run from a non-interactive session it will return NULL.
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX6.0.0.
Member Function Documentation
| iterator NXOpen::Display::DecalCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| NXOpen::Display::DecalBuilder* NXOpen::Display::DecalCollection::CreateDecalBuilder | ( | NXOpen::TaggedObject * | decal | ) |
Creates a NXOpen::Display::DecalBuilder object if decal is NULL.
Otherwise, a Decal object will be edited
- Returns
- return decal builder
Created in NX6.0.0.
License requirements : None
- Parameters
-
decal If decal is not NULL, then this object will be edited
| NXOpen::Display::DecalBuilder* NXOpen::Display::DecalCollection::CreateDecalBuilderFull | ( | NXOpen::TaggedObject * | decal | ) |
Creates a NXOpen::Display::DecalBuilder object with image referenced object if decal is NULL.
Otherwise, a Decal object will be edited
- Returns
- return decal builder
Created in NX6.0.0.
License requirements : None
- Parameters
-
decal If decal is not NULL, then this object will be edited
| iterator NXOpen::Display::DecalCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Decal* NXOpen::Display::DecalCollection::FindDecalObject | ( | const NXString & | journalIdentifier | ) |
Finds the NXOpen::Decal 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.
- Returns
- Decal found
Created in NX6.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier to be found
| NXOpen::Decal* NXOpen::Display::DecalCollection::FindDecalObject | ( | const char * | journalIdentifier | ) |
Finds the NXOpen::Decal 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.
- Returns
- Decal found
Created in NX6.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier to be found
| tag_t NXOpen::Display::DecalCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Display_DecalCollection.hxx