DecalCollection Class — NXOpen Python API Reference 12.0.0 documentation

# DecalCollection Class

class `NXOpen.Display.``DecalCollection`

  Bases: `object`

  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 None.

  To obtain an instance of this class, refer to `NXOpen.BasePart`

  New in version NX6.0.0.

# Methods

Method | Description
--- | ---
CreateDecalBuilder | Creates a `NXOpen.Display.DecalBuilder` object if decal is None.
CreateDecalBuilderFull | Creates a `NXOpen.Display.DecalBuilder` object with image referenced object if decal is None.
FindDecalObject | Finds the `NXOpen.Decal` with the given identifier as recorded in a journal.

# Method Detail

## CreateDecalBuilder

`DecalCollection.``CreateDecalBuilder`

  Creates a `NXOpen.Display.DecalBuilder` object if decal is None.

  Otherwise, a Decal object will be edited

  Signature `CreateDecalBuilder(decal)`

  Parameters: | decal (`NXOpen.TaggedObject`) – If decal is not None, then this object will be edited
  Returns: | return decal builder
  Return type: | `NXOpen.Display.DecalBuilder`

  New in version NX6.0.0.

  License requirements: None.

## CreateDecalBuilderFull

`DecalCollection.``CreateDecalBuilderFull`

  Creates a `NXOpen.Display.DecalBuilder` object with image referenced object if decal is None.

  Otherwise, a Decal object will be edited

  Signature `CreateDecalBuilderFull(decal)`

  Parameters: | decal (`NXOpen.TaggedObject`) – If decal is not None, then this object will be edited
  Returns: | return decal builder
  Return type: | `NXOpen.Display.DecalBuilder`

  New in version NX6.0.0.

  License requirements: None.

## FindDecalObject

`DecalCollection.``FindDecalObject`

  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.

  Signature `FindDecalObject(journalIdentifier)`

  Parameters: | journalIdentifier (str) – Identifier to be found
  Returns: | Decal found
  Return type: | `NXOpen.Decal`

  New in version NX6.0.0.

  License requirements: None.