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

Represents the collection of all NXOpen::PhysicalMaterial objects in this Part. More...

Inheritance diagram for NXOpen::PhysicalMaterialCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

bool AnyBodiesWithoutMaterial ()
 Returns true if there are bodies in the specified part that do not have a material assigned to them; false if all bodies in the part have a material assigned. More...
 
bool AnyBodiesWithoutPreferredMaterial ()
 Returns true if there are bodies that do not have the preferred material assigned to them and false if all bodies are assigned the preferred material. More...
 
iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::PhysicalMaterialCopyMaterialFromLibrary (const NXString &libraryName, const NXString &libraryReference)
 Creates an editable material (copy) in the part from a library material definition. More...
 
NXOpen::PhysicalMaterialCopyMaterialFromLibrary (const char *libraryName, const char *libraryReference)
 Creates an editable material (copy) in the part from a library material definition. More...
 
NXOpen::PhysicalMaterialCopyMaterialFromLibrary (const NXString &libraryName, const NXString &libraryReference, bool retainParentPedigree)
 Creates an editable material (copy) in the part from a library material definition. More...
 
NXOpen::PhysicalMaterialCopyMaterialFromLibrary (const char *libraryName, const char *libraryReference, bool retainParentPedigree)
 Creates an editable material (copy) in the part from a library material definition. More...
 
NXOpen::PhysicalMaterialCopyMaterialItemRevision (const NXString &pcMatlItem, const NXString &pcRevisionID)
 Creates an editable material (copy) in the part from a Teamcenter material item revision. More...
 
NXOpen::PhysicalMaterialCopyMaterialItemRevision (const char *pcMatlItem, const char *pcRevisionID)
 Creates an editable material (copy) in the part from a Teamcenter material item revision. More...
 
NXOpen::PhysMat::PhysicalMaterialListBuilderCreateListBlockBuilder ()
 Creates a NXOpen::PhysMat::PhysicalMaterialListBuilder that controls the physical materials list UI block look and feel as well as capturing the interactions so the values/settings can be journaled. More...
 
NXOpen::PhysMat::PhysicalMaterialAssignBuilderCreateMaterialAssignBuilder ()
 Creates a PhysMat.MaterialAssignBuilder that is used to control/set the material assign UI as well as to assign materials to bodies. More...
 
NXOpen::PhysMat::PhysicalMaterialLibMgrBuilderCreateMaterialLibmgrBuilder ()
 Creates a PhysMat.PhysicalMaterialLibMgrBuilder used by the material library manager UI to control the look and feel as well as capturing the interactions so the values/settings can be journaled. More...
 
NXOpen::PhysicalMaterialBuilderCreatePhysicalMaterialBuilder (NXOpen::PhysicalMaterial::Type materialType)
 Creates a PhysMat.PhysicalMaterialBuilder used to create a physical materials of a given type. More...
 
NXOpen::PhysicalMaterialBuilderCreatePhysicalMaterialEditBuilder (NXOpen::PhysicalMaterial *physicalMaterial)
 Creates a PhysMat.PhysicalMaterialBuilder used to edit physical materials. More...
 
NXOpen::PhysicalMaterialBuilderCreatePhysicalMaterialInspectBuilder (NXOpen::PhysicalMaterial *physicalMaterial)
 Creates a PhysMat.PhysicalMaterialBuilder used to inspect physical materials. More...
 
void DeleteMaterialsFromLibrary (std::vector< NXString > &pMatlNames, const NXString &pcLibName)
 Deletes the materials from a material library file. More...
 
void DeleteMaterialsFromLibrary (std::vector< NXString > &pMatlNames, const char *pcLibName)
 Deletes the materials from a material library file. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
void ExportMaterialsToLibrary (std::vector< NXString > &pcMatlNames, std::vector< NXString > &pcLibNames, const NXString &pcExportedLibName, const std::vector< bool > &bUpdateLibraryReference)
 Writes out materials to a material library file. More...
 
void ExportMaterialsToLibrary (std::vector< NXString > &pcMatlNames, std::vector< NXString > &pcLibNames, const char *pcExportedLibName, const std::vector< bool > &bUpdateLibraryReference)
 Writes out materials to a material library file. More...
 
void ExportMaterialsToLibrary (std::vector< NXString > &pcMatlNames, std::vector< NXString > &pcLibNames, const NXString &pcExportedLibName, bool bUpdateLibraryReference)
 Writes out materials to a material library file. More...
 
void ExportMaterialsToLibrary (std::vector< NXString > &pcMatlNames, std::vector< NXString > &pcLibNames, const char *pcExportedLibName, bool bUpdateLibraryReference)
 Writes out materials to a material library file. More...
 
void FindBodiesWithoutMaterial (std::vector< NXOpen::TaggedObject * > &objects)
 Returns the bodies that don't have a material assigned. More...
 
void FindBodiesWithoutPreferredMaterial (std::vector< NXOpen::TaggedObject * > &objects)
 Returns the bodies that are not using the preferred material (either no material assigned or the non-preferred a different material assigned). More...
 
NXOpen::MaterialFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::PhysicalMaterial with the given identifier as recorded in a journal. More...
 
NXOpen::MaterialFindObject (const char *journalIdentifier)
 Finds the NXOpen::PhysicalMaterial with the given identifier as recorded in a journal. More...
 
NXOpen::PhysicalMaterialGetLoadedLibraryMaterial (const NXString &pcLibName, const NXString &pcMatlName)
 Checks if a library material is loaded into a part file or not. More...
 
NXOpen::PhysicalMaterialGetLoadedLibraryMaterial (const char *pcLibName, const char *pcMatlName)
 Checks if a library material is loaded into a part file or not. More...
 
NXOpen::PhysicalMaterialGetLoadedMaterialItemRevision (const NXString &pcMatlItem, const NXString &pcRevisionID)
 Checks if a Teamcenter material item revision is loaded into a part file or not. More...
 
NXOpen::PhysicalMaterialGetLoadedMaterialItemRevision (const char *pcMatlItem, const char *pcRevisionID)
 Checks if a Teamcenter material item revision is loaded into a part file or not. More...
 
std::vector
< NXOpen::PhysicalMaterial * > 
GetUsedMaterials ()
 Returns the materials used in the part. More...
 
void InfoItemRevision (const NXString &pcMaterialItem, const NXString &pcRevision)
 Displays the property values for the specified Teamcenter Material Item Revision in the information window. More...
 
void InfoItemRevision (const char *pcMaterialItem, const char *pcRevision)
 Displays the property values for the specified Teamcenter Material Item Revision in the information window. More...
 
void InfoItemRevisionToFile (const NXString &pcMaterialItem, const NXString &pcRevision, bool bOverride, const NXString &pcFileName)
 Writes the property values for the specified Teamcenter Material Item Revision to a file. More...
 
void InfoItemRevisionToFile (const char *pcMaterialItem, const char *pcRevision, bool bOverride, const char *pcFileName)
 Writes the property values for the specified Teamcenter Material Item Revision to a file. More...
 
void InfoLibraryMaterial (const NXString &pcLibAr, const NXString &pcMatlNameAr)
 Displays the property values for the specified library material in the information window. More...
 
void InfoLibraryMaterial (const char *pcLibAr, const char *pcMatlNameAr)
 Displays the property values for the specified library material in the information window. More...
 
void InfoLibraryMaterialToFile (const NXString &pcLibAr, const NXString &pcMatlNameAr, bool bOverride, const NXString &pcFileName)
 Writes the property values for the specified library material to a file. More...
 
void InfoLibraryMaterialToFile (const char *pcLibAr, const char *pcMatlNameAr, bool bOverride, const char *pcFileName)
 Writes the property values for the specified library material to a file. More...
 
NXOpen::PhysicalMaterialLoadFromLegacynxlibrary (const NXString &libraryReference)
 Creates a non-editable material in the part from the legacy (phys_material.dat) material library definition. More...
 
NXOpen::PhysicalMaterialLoadFromLegacynxlibrary (const char *libraryReference)
 Creates a non-editable material in the part from the legacy (phys_material.dat) material library definition. More...
 
NXOpen::PhysicalMaterialLoadFromLibrary (const NXString &pcLibName, const NXString &pcMatlName)
 Creates a non-editable material in the part from a material library name. More...
 
NXOpen::PhysicalMaterialLoadFromLibrary (const char *pcLibName, const char *pcMatlName)
 Creates a non-editable material in the part from a material library name. More...
 
NXOpen::PhysicalMaterialLoadFromMatmlLibrary (const NXString &libraryName, const NXString &materialName)
 Creates a non-editable material in the part from a MatML file definition. More...
 
NXOpen::PhysicalMaterialLoadFromMatmlLibrary (const char *libraryName, const char *materialName)
 Creates a non-editable material in the part from a MatML file definition. More...
 
NXOpen::PhysicalMaterialLoadFromNxlibrary (const NXString &libraryReference)
 Creates a non-editable material in the part from a NX Material Library definition. More...
 
NXOpen::PhysicalMaterialLoadFromNxlibrary (const char *libraryReference)
 Creates a non-editable material in the part from a NX Material Library definition. More...
 
NXOpen::PhysicalMaterialLoadFromNxmatmllibrary (const NXString &materialName)
 Creates a non-editable material in the part from a NX MatML material definition. More...
 
NXOpen::PhysicalMaterialLoadFromNxmatmllibrary (const char *materialName)
 Creates a non-editable material in the part from a NX MatML material definition. More...
 
NXOpen::PhysicalMaterialLoadMaterialItemRevision (const NXString &pcMatlItem, const NXString &pcRevisionID)
 Creates a non-editable material in the part from a Teamcenter material item revision. More...
 
NXOpen::PhysicalMaterialLoadMaterialItemRevision (const char *pcMatlItem, const char *pcRevisionID)
 Creates a non-editable material in the part from a Teamcenter material item revision. More...
 
void OutputMaterialsToLibrary (std::vector< NXString > &pcMatlNames, std::vector< NXString > &pcLibNames, const NXString &pcExportedLibName)
 Writes out materials to a material library file. More...
 
void OutputMaterialsToLibrary (std::vector< NXString > &pcMatlNames, std::vector< NXString > &pcLibNames, const char *pcExportedLibName)
 Writes out materials to a material library file. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void UpdateMaterialsInLibrary (const std::vector< NXOpen::PhysicalMaterial * > &tEditedMatl, std::vector< NXString > &pMatlNames, const NXString &pcLibName)
 Updates the materials in a material library file. More...
 
void UpdateMaterialsInLibrary (const std::vector< NXOpen::PhysicalMaterial * > &tEditedMatl, std::vector< NXString > &pMatlNames, const char *pcLibName)
 Updates the materials in a material library file. More...
 

Detailed Description

Represents the collection of all NXOpen::PhysicalMaterial objects in this Part.


To obtain an instance of this class, refer to NXOpen::MaterialManager

Created in NX5.0.0.

Member Function Documentation

bool NXOpen::PhysicalMaterialCollection::AnyBodiesWithoutMaterial ( )

Returns true if there are bodies in the specified part that do not have a material assigned to them; false if all bodies in the part have a material assigned.

Returns

Created in NX7.5.2.

License requirements : None
bool NXOpen::PhysicalMaterialCollection::AnyBodiesWithoutPreferredMaterial ( )

Returns true if there are bodies that do not have the preferred material assigned to them and false if all bodies are assigned the preferred material.

If there is not a preferred material specified, the return value is true.

Returns

Created in NX7.5.3.

License requirements : None
iterator NXOpen::PhysicalMaterialCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::CopyMaterialFromLibrary ( const NXString libraryName,
const NXString libraryReference 
)

Creates an editable material (copy) in the part from a library material definition.

Returns
the copied material
Created in NX6.0.4.

License requirements : None
Parameters
libraryNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
libraryReferencethe material name/identifier
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::CopyMaterialFromLibrary ( const char *  libraryName,
const char *  libraryReference 
)

Creates an editable material (copy) in the part from a library material definition.

Returns
the copied material
Created in NX6.0.4.

License requirements : None
Parameters
libraryNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
libraryReferencethe material name/identifier
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::CopyMaterialFromLibrary ( const NXString libraryName,
const NXString libraryReference,
bool  retainParentPedigree 
)

Creates an editable material (copy) in the part from a library material definition.

Returns
the copied material
Created in NX8.5.0.

License requirements : None
Parameters
libraryNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
libraryReferencethe material name/identifier
retainParentPedigreetrue indicates that the copied material should retain information about what library material it came from
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::CopyMaterialFromLibrary ( const char *  libraryName,
const char *  libraryReference,
bool  retainParentPedigree 
)

Creates an editable material (copy) in the part from a library material definition.

Returns
the copied material
Created in NX8.5.0.

License requirements : None
Parameters
libraryNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
libraryReferencethe material name/identifier
retainParentPedigreetrue indicates that the copied material should retain information about what library material it came from
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::CopyMaterialItemRevision ( const NXString pcMatlItem,
const NXString pcRevisionID 
)

Creates an editable material (copy) in the part from a Teamcenter material item revision.

Returns
the copied material
Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::CopyMaterialItemRevision ( const char *  pcMatlItem,
const char *  pcRevisionID 
)

Creates an editable material (copy) in the part from a Teamcenter material item revision.

Returns
the copied material
Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
NXOpen::PhysMat::PhysicalMaterialListBuilder* NXOpen::PhysicalMaterialCollection::CreateListBlockBuilder ( )

Creates a NXOpen::PhysMat::PhysicalMaterialListBuilder that controls the physical materials list UI block look and feel as well as capturing the interactions so the values/settings can be journaled.

Returns
created NXOpen::PhysMat::PhysicalMaterialListBuilder
Created in NX6.0.0.

License requirements : None
NXOpen::PhysMat::PhysicalMaterialAssignBuilder* NXOpen::PhysicalMaterialCollection::CreateMaterialAssignBuilder ( )

Creates a PhysMat.MaterialAssignBuilder that is used to control/set the material assign UI as well as to assign materials to bodies.

Returns
created NXOpen::PhysMat::PhysicalMaterialAssignBuilder
Created in NX6.0.0.

License requirements : None
NXOpen::PhysMat::PhysicalMaterialLibMgrBuilder* NXOpen::PhysicalMaterialCollection::CreateMaterialLibmgrBuilder ( )

Creates a PhysMat.PhysicalMaterialLibMgrBuilder used by the material library manager UI to control the look and feel as well as capturing the interactions so the values/settings can be journaled.

Returns
created NXOpen::PhysMat::PhysicalMaterialLibMgrBuilder
Created in NX6.0.2.

License requirements : None
NXOpen::PhysicalMaterialBuilder* NXOpen::PhysicalMaterialCollection::CreatePhysicalMaterialBuilder ( NXOpen::PhysicalMaterial::Type  materialType)

Creates a PhysMat.PhysicalMaterialBuilder used to create a physical materials of a given type.

Returns
created NXOpen::PhysicalMaterialBuilder
Created in NX6.0.0.

License requirements : None
Parameters
materialTypeType of NXOpen::PhysicalMaterial to be created
NXOpen::PhysicalMaterialBuilder* NXOpen::PhysicalMaterialCollection::CreatePhysicalMaterialEditBuilder ( NXOpen::PhysicalMaterial physicalMaterial)

Creates a PhysMat.PhysicalMaterialBuilder used to edit physical materials.

Returns
created NXOpen::PhysicalMaterialBuilder
Created in NX6.0.0.

License requirements : None
Parameters
physicalMaterialNXOpen::PhysicalMaterial to be edited
NXOpen::PhysicalMaterialBuilder* NXOpen::PhysicalMaterialCollection::CreatePhysicalMaterialInspectBuilder ( NXOpen::PhysicalMaterial physicalMaterial)

Creates a PhysMat.PhysicalMaterialBuilder used to inspect physical materials.

Returns
created NXOpen::PhysicalMaterialBuilder
Created in NX7.5.0.

License requirements : None
Parameters
physicalMaterialNXOpen::PhysicalMaterial to be inspected
void NXOpen::PhysicalMaterialCollection::DeleteMaterialsFromLibrary ( std::vector< NXString > &  pMatlNames,
const NXString pcLibName 
)

Deletes the materials from a material library file.

Write access is needed for this operation.


Created in NX6.0.2.

License requirements : None

Parameters
pMatlNamesArrays of identifiers of the materials to be deleted from the library
pcLibNameLibrary to modify
void NXOpen::PhysicalMaterialCollection::DeleteMaterialsFromLibrary ( std::vector< NXString > &  pMatlNames,
const char *  pcLibName 
)

Deletes the materials from a material library file.

Write access is needed for this operation.


Created in NX6.0.2.

License requirements : None

Parameters
pMatlNamesArrays of identifiers of the materials to be deleted from the library
pcLibNameLibrary to modify
iterator NXOpen::PhysicalMaterialCollection::end ( )

Returns an iterator addressing one past the last element.

void NXOpen::PhysicalMaterialCollection::ExportMaterialsToLibrary ( std::vector< NXString > &  pcMatlNames,
std::vector< NXString > &  pcLibNames,
const NXString pcExportedLibName,
const std::vector< bool > &  bUpdateLibraryReference 
)

Writes out materials to a material library file.

These materials can be local material definitions or material definitions from other material libraries. The combination of the material name and library name identify a material definition. If the material definition is for a local material, the name is specified and the library name is specified as "". Write access is needed for the Exported library. If the bUpdateLibraryReferences is set to true, the NX model is updated to reflect the exported library as the library the material is now referenced in. Each material can have its own bUpdateLibraryReferences in this version of the JA call.


Created in NX11.0.2.

License requirements : None

Parameters
pcMatlNamesArray of identifiers of the materials to be exported
pcLibNamesArray of library names corresponding to the material names
pcExportedLibNameThe library to write the material definitions to
bUpdateLibraryReferencetrue indicates that the library reference of loaded/local materials should now refer to the exported library, false indicates the library reference should remain unchanged
void NXOpen::PhysicalMaterialCollection::ExportMaterialsToLibrary ( std::vector< NXString > &  pcMatlNames,
std::vector< NXString > &  pcLibNames,
const char *  pcExportedLibName,
const std::vector< bool > &  bUpdateLibraryReference 
)

Writes out materials to a material library file.

These materials can be local material definitions or material definitions from other material libraries. The combination of the material name and library name identify a material definition. If the material definition is for a local material, the name is specified and the library name is specified as "". Write access is needed for the Exported library. If the bUpdateLibraryReferences is set to true, the NX model is updated to reflect the exported library as the library the material is now referenced in. Each material can have its own bUpdateLibraryReferences in this version of the JA call.


Created in NX11.0.2.

License requirements : None

Parameters
pcMatlNamesArray of identifiers of the materials to be exported
pcLibNamesArray of library names corresponding to the material names
pcExportedLibNameThe library to write the material definitions to
bUpdateLibraryReferencetrue indicates that the library reference of loaded/local materials should now refer to the exported library, false indicates the library reference should remain unchanged
void NXOpen::PhysicalMaterialCollection::ExportMaterialsToLibrary ( std::vector< NXString > &  pcMatlNames,
std::vector< NXString > &  pcLibNames,
const NXString pcExportedLibName,
bool  bUpdateLibraryReference 
)

Writes out materials to a material library file.

These materials can be local material definitions or material definitions from other material libraries. The combination of the material name and library name identify a material definition. If the material definition is for a local material, the name is specified and the library name is specified as "". Write access is needed for the Exported library. If the bUpdateLibraryReferences is set to true, the NX model is updated to reflect the exported library as the library the material is now referenced in.


Created in NX7.5.2.

License requirements : None

Parameters
pcMatlNamesArray of identifiers of the materials to be exported
pcLibNamesArray of library names corresponding to the material names
pcExportedLibNameThe library to write the material definitions to
bUpdateLibraryReferencetrue indicates that the library reference of loaded/local materials should now refer to the exported library, false indicates the library reference should remain unchanged
void NXOpen::PhysicalMaterialCollection::ExportMaterialsToLibrary ( std::vector< NXString > &  pcMatlNames,
std::vector< NXString > &  pcLibNames,
const char *  pcExportedLibName,
bool  bUpdateLibraryReference 
)

Writes out materials to a material library file.

These materials can be local material definitions or material definitions from other material libraries. The combination of the material name and library name identify a material definition. If the material definition is for a local material, the name is specified and the library name is specified as "". Write access is needed for the Exported library. If the bUpdateLibraryReferences is set to true, the NX model is updated to reflect the exported library as the library the material is now referenced in.


Created in NX7.5.2.

License requirements : None

Parameters
pcMatlNamesArray of identifiers of the materials to be exported
pcLibNamesArray of library names corresponding to the material names
pcExportedLibNameThe library to write the material definitions to
bUpdateLibraryReferencetrue indicates that the library reference of loaded/local materials should now refer to the exported library, false indicates the library reference should remain unchanged
void NXOpen::PhysicalMaterialCollection::FindBodiesWithoutMaterial ( std::vector< NXOpen::TaggedObject * > &  objects)

Returns the bodies that don't have a material assigned.


Created in NX7.5.2.

License requirements : None

Parameters
objectsthe array of bodies without a material
void NXOpen::PhysicalMaterialCollection::FindBodiesWithoutPreferredMaterial ( std::vector< NXOpen::TaggedObject * > &  objects)

Returns the bodies that are not using the preferred material (either no material assigned or the non-preferred a different material assigned).


Created in NX7.5.2.

License requirements : None

Parameters
objectsthe array of bodies not using preferred material
NXOpen::Material* NXOpen::PhysicalMaterialCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::PhysicalMaterial with the given identifier as recorded in a journal.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
material found
Created in NX5.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
NXOpen::Material* NXOpen::PhysicalMaterialCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::PhysicalMaterial with the given identifier as recorded in a journal.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
material found
Created in NX5.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::GetLoadedLibraryMaterial ( const NXString pcLibName,
const NXString pcMatlName 
)

Checks if a library material is loaded into a part file or not.

If it is, the loaded material is returned.

Returns
the loaded material
Created in NX7.5.3.

License requirements : None
Parameters
pcLibNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
pcMatlNamethe material name
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::GetLoadedLibraryMaterial ( const char *  pcLibName,
const char *  pcMatlName 
)

Checks if a library material is loaded into a part file or not.

If it is, the loaded material is returned.

Returns
the loaded material
Created in NX7.5.3.

License requirements : None
Parameters
pcLibNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
pcMatlNamethe material name
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::GetLoadedMaterialItemRevision ( const NXString pcMatlItem,
const NXString pcRevisionID 
)

Checks if a Teamcenter material item revision is loaded into a part file or not.

If it is, the loaded material is returned.

Returns
the loaded material
Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::GetLoadedMaterialItemRevision ( const char *  pcMatlItem,
const char *  pcRevisionID 
)

Checks if a Teamcenter material item revision is loaded into a part file or not.

If it is, the loaded material is returned.

Returns
the loaded material
Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
std::vector<NXOpen::PhysicalMaterial *> NXOpen::PhysicalMaterialCollection::GetUsedMaterials ( )

Returns the materials used in the part.

Returns
Materials used
Created in NX8.0.1.

License requirements : None
void NXOpen::PhysicalMaterialCollection::InfoItemRevision ( const NXString pcMaterialItem,
const NXString pcRevision 
)

Displays the property values for the specified Teamcenter Material Item Revision in the information window.


Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMaterialItemthe material item
pcRevisionthe revision identifier
void NXOpen::PhysicalMaterialCollection::InfoItemRevision ( const char *  pcMaterialItem,
const char *  pcRevision 
)

Displays the property values for the specified Teamcenter Material Item Revision in the information window.


Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMaterialItemthe material item
pcRevisionthe revision identifier
void NXOpen::PhysicalMaterialCollection::InfoItemRevisionToFile ( const NXString pcMaterialItem,
const NXString pcRevision,
bool  bOverride,
const NXString pcFileName 
)

Writes the property values for the specified Teamcenter Material Item Revision to a file.


Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMaterialItemthe material item
pcRevisionthe revision identifier
bOverrideif the file already exists, true override the file, false append to the file
pcFileNamethe full path including filename of file where the information should be written
void NXOpen::PhysicalMaterialCollection::InfoItemRevisionToFile ( const char *  pcMaterialItem,
const char *  pcRevision,
bool  bOverride,
const char *  pcFileName 
)

Writes the property values for the specified Teamcenter Material Item Revision to a file.


Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMaterialItemthe material item
pcRevisionthe revision identifier
bOverrideif the file already exists, true override the file, false append to the file
pcFileNamethe full path including filename of file where the information should be written
void NXOpen::PhysicalMaterialCollection::InfoLibraryMaterial ( const NXString pcLibAr,
const NXString pcMatlNameAr 
)

Displays the property values for the specified library material in the information window.


Created in NX7.5.3.

License requirements : None

Parameters
pcLibArthe library name
pcMatlNameArthe material name
void NXOpen::PhysicalMaterialCollection::InfoLibraryMaterial ( const char *  pcLibAr,
const char *  pcMatlNameAr 
)

Displays the property values for the specified library material in the information window.


Created in NX7.5.3.

License requirements : None

Parameters
pcLibArthe library name
pcMatlNameArthe material name
void NXOpen::PhysicalMaterialCollection::InfoLibraryMaterialToFile ( const NXString pcLibAr,
const NXString pcMatlNameAr,
bool  bOverride,
const NXString pcFileName 
)

Writes the property values for the specified library material to a file.


Created in NX7.5.3.

License requirements : None

Parameters
pcLibArthe library name
pcMatlNameArthe material name
bOverrideif the file already exists, true override the file, false append to the file
pcFileNamethe full path including filename of file where the information should be written
void NXOpen::PhysicalMaterialCollection::InfoLibraryMaterialToFile ( const char *  pcLibAr,
const char *  pcMatlNameAr,
bool  bOverride,
const char *  pcFileName 
)

Writes the property values for the specified library material to a file.


Created in NX7.5.3.

License requirements : None

Parameters
pcLibArthe library name
pcMatlNameArthe material name
bOverrideif the file already exists, true override the file, false append to the file
pcFileNamethe full path including filename of file where the information should be written
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromLegacynxlibrary ( const NXString libraryReference)

Creates a non-editable material in the part from the legacy (phys_material.dat) material library definition.

The material is identified by the unique material identifier in the phys_material.dat file.

Returns
the loaded material
Created in NX7.5.0.

License requirements : None
Parameters
libraryReferencethe unique library reference for a material in this Library
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromLegacynxlibrary ( const char *  libraryReference)

Creates a non-editable material in the part from the legacy (phys_material.dat) material library definition.

The material is identified by the unique material identifier in the phys_material.dat file.

Returns
the loaded material
Created in NX7.5.0.

License requirements : None
Parameters
libraryReferencethe unique library reference for a material in this Library
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromLibrary ( const NXString pcLibName,
const NXString pcMatlName 
)

Creates a non-editable material in the part from a material library name.

Returns
the loaded material
Created in NX7.5.3.

License requirements : None
Parameters
pcLibNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
pcMatlNamethe material name
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromLibrary ( const char *  pcLibName,
const char *  pcMatlName 
)

Creates a non-editable material in the part from a material library name.

Returns
the loaded material
Created in NX7.5.3.

License requirements : None
Parameters
pcLibNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
pcMatlNamethe material name
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromMatmlLibrary ( const NXString libraryName,
const NXString materialName 
)

Creates a non-editable material in the part from a MatML file definition.

The material is identified by the library name and the unique material name. If the library name is not fully qualified, it will attempt to find a MatML library with this name in the current directory, followed by the specified customer defaults values for the user and site MatML libraries. If the customer defaults are using the file format, it will look in the directory where the specified file is located.

Returns
the loaded material
Created in NX6.0.2.

License requirements : None
Parameters
libraryNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
materialNamethe material name
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromMatmlLibrary ( const char *  libraryName,
const char *  materialName 
)

Creates a non-editable material in the part from a MatML file definition.

The material is identified by the library name and the unique material name. If the library name is not fully qualified, it will attempt to find a MatML library with this name in the current directory, followed by the specified customer defaults values for the user and site MatML libraries. If the customer defaults are using the file format, it will look in the directory where the specified file is located.

Returns
the loaded material
Created in NX6.0.2.

License requirements : None
Parameters
libraryNamethe fully qualified library name or if the leaf it will use the current directory, followed by the user and site directories set up in the customer defaults
materialNamethe material name
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromNxlibrary ( const NXString libraryReference)

Creates a non-editable material in the part from a NX Material Library definition.

It is preferable to use either NX MatML or NX Legacy library versions as they will have better performance.

Returns
the loaded material
Created in NX6.0.0.

License requirements : None
Parameters
libraryReferencethe unique library reference for a material in this Library
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromNxlibrary ( const char *  libraryReference)

Creates a non-editable material in the part from a NX Material Library definition.

It is preferable to use either NX MatML or NX Legacy library versions as they will have better performance.

Returns
the loaded material
Created in NX6.0.0.

License requirements : None
Parameters
libraryReferencethe unique library reference for a material in this Library
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromNxmatmllibrary ( const NXString materialName)

Creates a non-editable material in the part from a NX MatML material definition.

Returns
the loaded material
Created in NX7.5.0.

License requirements : None
Parameters
materialNamethe unique material name from within this Library
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadFromNxmatmllibrary ( const char *  materialName)

Creates a non-editable material in the part from a NX MatML material definition.

Returns
the loaded material
Created in NX7.5.0.

License requirements : None
Parameters
materialNamethe unique material name from within this Library
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadMaterialItemRevision ( const NXString pcMatlItem,
const NXString pcRevisionID 
)

Creates a non-editable material in the part from a Teamcenter material item revision.

Returns
the loaded material
Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterialCollection::LoadMaterialItemRevision ( const char *  pcMatlItem,
const char *  pcRevisionID 
)

Creates a non-editable material in the part from a Teamcenter material item revision.

Returns
the loaded material
Deprecated:
Deprecated in NX12.0.0. Teamcenter material item revision is no longer supported.


Created in NX7.5.3.

License requirements : None

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
void NXOpen::PhysicalMaterialCollection::OutputMaterialsToLibrary ( std::vector< NXString > &  pcMatlNames,
std::vector< NXString > &  pcLibNames,
const NXString pcExportedLibName 
)

Writes out materials to a material library file.

These materials can be local material definitions or material definitions from other material libraries. The combination of the material name and library name identify a material definition. If the material definition is for a local material, the name is specified and the library name is specified as "". Write access is needed for the Exported library.
Created in NX6.0.2.

License requirements : None

Parameters
pcMatlNamesArray of identifiers of the materials to be exported
pcLibNamesArray of library names corresponding to the material names
pcExportedLibNameThe library to write the material definitions to
void NXOpen::PhysicalMaterialCollection::OutputMaterialsToLibrary ( std::vector< NXString > &  pcMatlNames,
std::vector< NXString > &  pcLibNames,
const char *  pcExportedLibName 
)

Writes out materials to a material library file.

These materials can be local material definitions or material definitions from other material libraries. The combination of the material name and library name identify a material definition. If the material definition is for a local material, the name is specified and the library name is specified as "". Write access is needed for the Exported library.
Created in NX6.0.2.

License requirements : None

Parameters
pcMatlNamesArray of identifiers of the materials to be exported
pcLibNamesArray of library names corresponding to the material names
pcExportedLibNameThe library to write the material definitions to
tag_t NXOpen::PhysicalMaterialCollection::Tag ( ) const

Returns the tag of this object.

void NXOpen::PhysicalMaterialCollection::UpdateMaterialsInLibrary ( const std::vector< NXOpen::PhysicalMaterial * > &  tEditedMatl,
std::vector< NXString > &  pMatlNames,
const NXString pcLibName 
)

Updates the materials in a material library file.

Write access is needed for this operation.


Created in NX6.0.2.

License requirements : None

Parameters
tEditedMatlArray of loaded material tags
pMatlNamesArray of the material names which match the name in the library that should take the properties of the corresponding material (tEditedMatl)
pcLibNameLibrary to modify
void NXOpen::PhysicalMaterialCollection::UpdateMaterialsInLibrary ( const std::vector< NXOpen::PhysicalMaterial * > &  tEditedMatl,
std::vector< NXString > &  pMatlNames,
const char *  pcLibName 
)

Updates the materials in a material library file.

Write access is needed for this operation.


Created in NX6.0.2.

License requirements : None

Parameters
tEditedMatlArray of loaded material tags
pMatlNamesArray of the material names which match the name in the library that should take the properties of the corresponding material (tEditedMatl)
pcLibNameLibrary to modify

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