NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Display.DecalCollection Class Reference

Represents a collection decal material texture More...

Inheritance diagram for NXOpen.Display.DecalCollection:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Member Functions

unsafe NXOpen.Display.DecalBuilder CreateDecalBuilder (NXOpen.TaggedObject decal)
 Creates a NXOpen.Display.DecalBuilder object if decal is a null reference (Nothing in Visual Basic). More...
 
unsafe NXOpen.Display.DecalBuilder CreateDecalBuilderFull (NXOpen.TaggedObject decal)
 Creates a NXOpen.Display.DecalBuilder object with image referenced object if decal is a null reference (Nothing in Visual Basic). More...
 
unsafe NXOpen.Decal FindDecalObject (string journalIdentifier)
 Finds the NXOpen.Decal with the given identifier as recorded in a journal. More...
 
NXOpen.Decal[] ToArray ()
 Returns an array of NXOpen.Decal objects. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 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 a null reference (Nothing in Visual Basic).

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

Created in NX6.0.0

Member Function Documentation

unsafe NXOpen.Display.DecalBuilder NXOpen.Display.DecalCollection.CreateDecalBuilder ( NXOpen.TaggedObject  decal)
inline

Creates a NXOpen.Display.DecalBuilder object if decal is a null reference (Nothing in Visual Basic).

Otherwise, a Decal object will be edited

Created in NX6.0.0

License requirements: None.

Parameters
decalIf decal is not a null reference (Nothing in Visual Basic), then this object will be edited
Returns
return decal builder
unsafe NXOpen.Display.DecalBuilder NXOpen.Display.DecalCollection.CreateDecalBuilderFull ( NXOpen.TaggedObject  decal)
inline

Creates a NXOpen.Display.DecalBuilder object with image referenced object if decal is a null reference (Nothing in Visual Basic).

Otherwise, a Decal object will be edited

Created in NX6.0.0

License requirements: None.

Parameters
decalIf decal is not a null reference (Nothing in Visual Basic), then this object will be edited
Returns
return decal builder
override int NXOpen.Display.DecalCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.Decal NXOpen.Display.DecalCollection.FindDecalObject ( string  journalIdentifier)
inline

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.

Created in NX6.0.0

License requirements: None.

Parameters
journalIdentifierIdentifier to be found
Returns
Decal found
NXOpen.Decal [] NXOpen.Display.DecalCollection.ToArray ( )
inline

Returns an array of NXOpen.Decal objects.

Property Documentation

Tag NXOpen.Display.DecalCollection.Tag
get

Returns the tag of this object.


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