NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::Display::CgfxAttrCollection Class Reference

Represents a collection CgFX attr ja_class objects
This class is restricted to being called from a program running during an Interactive NX session. More...

Inheritance diagram for NXOpen::Display::CgfxAttrCollection:
NXOpen::TaggedObjectCollection

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::CgfxAttributeValueColor3BuilderCreateAttributeValueColor3Builder (NXOpen::TaggedObject *cgfxAttribute)
 Creates a NXOpen::Display::CgfxAttributeValueColor3Builder object. More...
 
NXOpen::Display::CgfxAttributeValueColor4BuilderCreateAttributeValueColor4Builder (NXOpen::TaggedObject *cgfxAttribute)
 Creates a NXOpen::Display::CgfxAttributeValueColor4Builder object. More...
 
NXOpen::Display::CgfxAttributeValueFileBuilderCreateAttributeValueFileBuilder (NXOpen::TaggedObject *cgfxAttribute)
 Creates a NXOpen::Display::CgfxAttributeValueFileBuilder object. More...
 
NXOpen::Display::CgfxAttributeValueFloat3BuilderCreateAttributeValueFloat3Builder (NXOpen::TaggedObject *cgfxAttribute)
 Creates a NXOpen::Display::CgfxAttributeValueFloat3Builder object. More...
 
NXOpen::Display::CgfxAttributeValueFloat4BuilderCreateAttributeValueFloat4Builder (NXOpen::TaggedObject *cgfxAttribute)
 Creates a NXOpen::Display::CgfxAttributeValueFloat4Builder object. More...
 
NXOpen::Display::CgfxAttributeValueIntegerBuilderCreateAttributeValueIntegerBuilder (NXOpen::TaggedObject *cgfxAttribute)
 Creates a NXOpen::Display::CgfxAttributeValueIntegerBuilder object. More...
 
NXOpen::Display::CgfxAttributeValueNumberBuilderCreateAttributeValueNumberBuilder (NXOpen::TaggedObject *cgfxAttribute)
 Creates a NXOpen::Display::CgfxAttributeValueNumberBuilder object. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the NXOpen::Display::CgfxAttr with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Finds the NXOpen::Display::CgfxAttr 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 CgFX attr ja_class objects
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

Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

Member Function Documentation

iterator NXOpen::Display::CgfxAttrCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Display::CgfxAttributeValueColor3Builder* NXOpen::Display::CgfxAttrCollection::CreateAttributeValueColor3Builder ( NXOpen::TaggedObject cgfxAttribute)

Creates a NXOpen::Display::CgfxAttributeValueColor3Builder object.

Returns

Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
cgfxAttributeIf cgfxAttribute is not NULL, then this object will be edited
NXOpen::Display::CgfxAttributeValueColor4Builder* NXOpen::Display::CgfxAttrCollection::CreateAttributeValueColor4Builder ( NXOpen::TaggedObject cgfxAttribute)

Creates a NXOpen::Display::CgfxAttributeValueColor4Builder object.

Returns

Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
cgfxAttributeIf cgfxAttribute is not NULL, then this object will be edited
NXOpen::Display::CgfxAttributeValueFileBuilder* NXOpen::Display::CgfxAttrCollection::CreateAttributeValueFileBuilder ( NXOpen::TaggedObject cgfxAttribute)

Creates a NXOpen::Display::CgfxAttributeValueFileBuilder object.

Returns

Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
cgfxAttributeIf cgfxAttribute is not NULL, then this object will be edited
NXOpen::Display::CgfxAttributeValueFloat3Builder* NXOpen::Display::CgfxAttrCollection::CreateAttributeValueFloat3Builder ( NXOpen::TaggedObject cgfxAttribute)

Creates a NXOpen::Display::CgfxAttributeValueFloat3Builder object.

Returns

Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
cgfxAttributeIf cgfxAttribute is not NULL, then this object will be edited
NXOpen::Display::CgfxAttributeValueFloat4Builder* NXOpen::Display::CgfxAttrCollection::CreateAttributeValueFloat4Builder ( NXOpen::TaggedObject cgfxAttribute)

Creates a NXOpen::Display::CgfxAttributeValueFloat4Builder object.

Returns

Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
cgfxAttributeIf cgfxAttribute is not NULL, then this object will be edited
NXOpen::Display::CgfxAttributeValueIntegerBuilder* NXOpen::Display::CgfxAttrCollection::CreateAttributeValueIntegerBuilder ( NXOpen::TaggedObject cgfxAttribute)

Creates a NXOpen::Display::CgfxAttributeValueIntegerBuilder object.

Returns

Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
cgfxAttributeIf cgfxAttribute is not NULL, then this object will be edited
NXOpen::Display::CgfxAttributeValueNumberBuilder* NXOpen::Display::CgfxAttrCollection::CreateAttributeValueNumberBuilder ( NXOpen::TaggedObject cgfxAttribute)

Creates a NXOpen::Display::CgfxAttributeValueNumberBuilder object.

Returns

Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
cgfxAttributeIf cgfxAttribute is not NULL, then this object will be edited
iterator NXOpen::Display::CgfxAttrCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::TaggedObject* NXOpen::Display::CgfxAttrCollection::Find ( const NXString journalIdentifier)

Finds the NXOpen::Display::CgfxAttr 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
cgfx mattex found
Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
journalIdentifierIdentifier to be found
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::TaggedObject* NXOpen::Display::CgfxAttrCollection::Find ( const char *  journalIdentifier)

Finds the NXOpen::Display::CgfxAttr 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
cgfx mattex found
Deprecated:
Deprecated in NX10.0.0. No alternative provided for this class.


Created in NX5.0.0.

License requirements : None

Parameters
journalIdentifierIdentifier to be found
NOTE: The full Unicode character set is not supported for this parameter.
tag_t NXOpen::Display::CgfxAttrCollection::Tag ( ) const

Returns the tag of this object.


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