NXOpen .NET Reference  12.0.0
Public Member Functions | Protected Member Functions | Properties | 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:

Public Member Functions

NXOpen.Material[] ToArray ()
 Returns an array of NXOpen.Material objects. More...
 
unsafe NXOpen.Material FindObject (string journalIdentifier)
 Finds the NXOpen.PhysicalMaterial with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.PhysMat.PhysicalMaterialListBuilder 
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. More...
 
unsafe
NXOpen.PhysMat.PhysicalMaterialAssignBuilder 
CreateMaterialAssignBuilder ()
 Creates a PhysMat. More...
 
unsafe
NXOpen.PhysicalMaterialBuilder 
CreatePhysicalMaterialEditBuilder (NXOpen.PhysicalMaterial physicalMaterial)
 Creates a PhysMat. More...
 
unsafe
NXOpen.PhysicalMaterialBuilder 
CreatePhysicalMaterialInspectBuilder (NXOpen.PhysicalMaterial physicalMaterial)
 Creates a PhysMat. More...
 
unsafe
NXOpen.PhysicalMaterialBuilder 
CreatePhysicalMaterialBuilder (NXOpen.PhysicalMaterial.Type materialType)
 Creates a PhysMat. More...
 
unsafe
NXOpen.PhysMat.PhysicalMaterialLibMgrBuilder 
CreateMaterialLibmgrBuilder ()
 Creates a PhysMat. More...
 
unsafe NXOpen.PhysicalMaterial LoadFromNxlibrary (string libraryReference)
 Creates a non-editable material in the part from a NX Material Library definition. More...
 
unsafe NXOpen.PhysicalMaterial LoadFromMatmlLibrary (string libraryName, string materialName)
 Creates a non-editable material in the part from a MatML file definition. More...
 
unsafe NXOpen.PhysicalMaterial LoadFromLegacynxlibrary (string libraryReference)
 Creates a non-editable material in the part from the legacy (phys_material. More...
 
unsafe NXOpen.PhysicalMaterial LoadFromNxmatmllibrary (string materialName)
 Creates a non-editable material in the part from a NX MatML material definition. More...
 
unsafe NXOpen.PhysicalMaterial LoadFromLibrary (string pcLibName, string pcMatlName)
 Creates a non-editable material in the part from a material library name. More...
 
unsafe NXOpen.PhysicalMaterial LoadMaterialItemRevision (string pcMatlItem, string pcRevisionID)
 Creates a non-editable material in the part from a Teamcenter material item revision. More...
 
unsafe NXOpen.PhysicalMaterial GetLoadedMaterialItemRevision (string pcMatlItem, string pcRevisionID)
 Checks if a Teamcenter material item revision is loaded into a part file or not. More...
 
unsafe NXOpen.PhysicalMaterial GetLoadedLibraryMaterial (string pcLibName, string pcMatlName)
 Checks if a library material is loaded into a part file or not. More...
 
unsafe NXOpen.PhysicalMaterial CopyMaterialFromLibrary (string libraryName, string libraryReference)
 Creates an editable material (copy) in the part from a library material definition. More...
 
unsafe NXOpen.PhysicalMaterial CopyMaterialFromLibrary (string libraryName, string libraryReference, bool retainParentPedigree)
 Creates an editable material (copy) in the part from a library material definition. More...
 
unsafe NXOpen.PhysicalMaterial CopyMaterialItemRevision (string pcMatlItem, string pcRevisionID)
 Creates an editable material (copy) in the part from a Teamcenter material item revision. More...
 
unsafe void OutputMaterialsToLibrary (string[] pcMatlNames, string[] pcLibNames, string pcExportedLibName)
 Writes out materials to a material library file. More...
 
unsafe void ExportMaterialsToLibrary (string[] pcMatlNames, string[] pcLibNames, string pcExportedLibName, bool[] bUpdateLibraryReference)
 Writes out materials to a material library file. More...
 
unsafe void ExportMaterialsToLibrary (string[] pcMatlNames, string[] pcLibNames, string pcExportedLibName, bool bUpdateLibraryReference)
 Writes out materials to a material library file. More...
 
unsafe void UpdateMaterialsInLibrary (NXOpen.PhysicalMaterial[] tEditedMatl, string[] pMatlNames, string pcLibName)
 Updates the materials in a material library file. More...
 
unsafe void DeleteMaterialsFromLibrary (string[] pMatlNames, string pcLibName)
 Deletes the materials from a material library file. More...
 
unsafe void FindBodiesWithoutMaterial (out NXOpen.TaggedObject[] objects)
 Returns the bodies that don't have a material assigned. More...
 
unsafe 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...
 
unsafe void FindBodiesWithoutPreferredMaterial (out 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...
 
unsafe 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...
 
unsafe void InfoLibraryMaterial (string pcLibAr, string pcMatlNameAr)
 Displays the property values for the specified library material in the information window. More...
 
unsafe void InfoLibraryMaterialToFile (string pcLibAr, string pcMatlNameAr, bool bOverride, string pcFileName)
 Writes the property values for the specified library material to a file. More...
 
unsafe void InfoItemRevision (string pcMaterialItem, string pcRevision)
 Displays the property values for the specified Teamcenter Material Item Revision in the information window. More...
 
unsafe void InfoItemRevisionToFile (string pcMaterialItem, string pcRevision, bool bOverride, string pcFileName)
 Writes the property values for the specified Teamcenter Material Item Revision to a file. More...
 
unsafe NXOpen.PhysicalMaterial[] GetUsedMaterials ()
 Returns the materials used in the part More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. 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

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

Created in NX7.5.2

License requirements: None.

Returns
unsafe 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.

Created in NX7.5.3

License requirements: None.

Returns
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.CopyMaterialFromLibrary ( string  libraryName,
string  libraryReference 
)

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

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
Returns
the copied material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.CopyMaterialFromLibrary ( string  libraryName,
string  libraryReference,
bool  retainParentPedigree 
)

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

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
Returns
the copied material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.CopyMaterialItemRevision ( string  pcMatlItem,
string  pcRevisionID 
)

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

Created in NX7.5.3

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

License requirements: None.

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
Returns
the copied material
unsafe 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.

Created in NX6.0.0

License requirements: None.

Returns
created NXOpen.PhysMat.PhysicalMaterialListBuilder
unsafe 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.

Created in NX6.0.0

License requirements: None.

Returns
created NXOpen.PhysMat.PhysicalMaterialAssignBuilder
unsafe 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.

Created in NX6.0.2

License requirements: None.

Returns
created NXOpen.PhysMat.PhysicalMaterialLibMgrBuilder
unsafe NXOpen.PhysicalMaterialBuilder NXOpen.PhysicalMaterialCollection.CreatePhysicalMaterialBuilder ( NXOpen.PhysicalMaterial.Type  materialType)

Creates a PhysMat.

PhysicalMaterialBuilder used to create a physical materials of a given type

Created in NX6.0.0

License requirements: None.

Parameters
materialTypeType of NXOpen.PhysicalMaterial to be created
Returns
created NXOpen.PhysicalMaterialBuilder
unsafe NXOpen.PhysicalMaterialBuilder NXOpen.PhysicalMaterialCollection.CreatePhysicalMaterialEditBuilder ( NXOpen.PhysicalMaterial  physicalMaterial)

Creates a PhysMat.

PhysicalMaterialBuilder used to edit physical materials.

Created in NX6.0.0

License requirements: None.

Parameters
physicalMaterialNXOpen.PhysicalMaterial to be edited
Returns
created NXOpen.PhysicalMaterialBuilder
unsafe NXOpen.PhysicalMaterialBuilder NXOpen.PhysicalMaterialCollection.CreatePhysicalMaterialInspectBuilder ( NXOpen.PhysicalMaterial  physicalMaterial)

Creates a PhysMat.

PhysicalMaterialBuilder used to inspect physical materials.

Created in NX7.5.0

License requirements: None.

Parameters
physicalMaterialNXOpen.PhysicalMaterial to be inspected
Returns
created NXOpen.PhysicalMaterialBuilder
unsafe void NXOpen.PhysicalMaterialCollection.DeleteMaterialsFromLibrary ( string[]  pMatlNames,
string  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
override int NXOpen.PhysicalMaterialCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
protected

Advances the enumerator to the next element of the collection.

unsafe void NXOpen.PhysicalMaterialCollection.ExportMaterialsToLibrary ( string[]  pcMatlNames,
string[]  pcLibNames,
string  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. 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
unsafe void NXOpen.PhysicalMaterialCollection.ExportMaterialsToLibrary ( string[]  pcMatlNames,
string[]  pcLibNames,
string  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
unsafe void NXOpen.PhysicalMaterialCollection.FindBodiesWithoutMaterial ( out 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
unsafe void NXOpen.PhysicalMaterialCollection.FindBodiesWithoutPreferredMaterial ( out 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
unsafe NXOpen.Material NXOpen.PhysicalMaterialCollection.FindObject ( string  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.

Created in NX5.0.0

License requirements: None.

Parameters
journalIdentifierIdentifier to be found
Returns
material found
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.GetLoadedLibraryMaterial ( string  pcLibName,
string  pcMatlName 
)

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

If it is, the loaded material is returned.

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
Returns
the loaded material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.GetLoadedMaterialItemRevision ( string  pcMatlItem,
string  pcRevisionID 
)

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

If it is, the loaded material is returned.

Created in NX7.5.3

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

License requirements: None.

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
Returns
the loaded material
unsafe NXOpen.PhysicalMaterial [] NXOpen.PhysicalMaterialCollection.GetUsedMaterials ( )

Returns the materials used in the part

Created in NX8.0.1

License requirements: None.

Returns
Materials used
unsafe void NXOpen.PhysicalMaterialCollection.InfoItemRevision ( string  pcMaterialItem,
string  pcRevision 
)

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

Created in NX7.5.3

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

License requirements: None.

Parameters
pcMaterialItemthe material item
pcRevisionthe revision identifier
unsafe void NXOpen.PhysicalMaterialCollection.InfoItemRevisionToFile ( string  pcMaterialItem,
string  pcRevision,
bool  bOverride,
string  pcFileName 
)

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

Created in NX7.5.3

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

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
unsafe void NXOpen.PhysicalMaterialCollection.InfoLibraryMaterial ( string  pcLibAr,
string  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
unsafe void NXOpen.PhysicalMaterialCollection.InfoLibraryMaterialToFile ( string  pcLibAr,
string  pcMatlNameAr,
bool  bOverride,
string  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
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.LoadFromLegacynxlibrary ( string  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.

Created in NX7.5.0

License requirements: None.

Parameters
libraryReferencethe unique library reference for a material in this Library
Returns
the loaded material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.LoadFromLibrary ( string  pcLibName,
string  pcMatlName 
)

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

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
Returns
the loaded material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.LoadFromMatmlLibrary ( string  libraryName,
string  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.

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
Returns
the loaded material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.LoadFromNxlibrary ( string  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.

Created in NX6.0.0

License requirements: None.

Parameters
libraryReferencethe unique library reference for a material in this Library
Returns
the loaded material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.LoadFromNxmatmllibrary ( string  materialName)

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

Created in NX7.5.0

License requirements: None.

Parameters
materialNamethe unique material name from within this Library
Returns
the loaded material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterialCollection.LoadMaterialItemRevision ( string  pcMatlItem,
string  pcRevisionID 
)

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

Created in NX7.5.3

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

License requirements: None.

Parameters
pcMatlItemthe material item
pcRevisionIDthe revision identifier
Returns
the loaded material
unsafe void NXOpen.PhysicalMaterialCollection.OutputMaterialsToLibrary ( string[]  pcMatlNames,
string[]  pcLibNames,
string  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
NXOpen.Material [] NXOpen.PhysicalMaterialCollection.ToArray ( )

Returns an array of NXOpen.Material objects.

unsafe void NXOpen.PhysicalMaterialCollection.UpdateMaterialsInLibrary ( NXOpen.PhysicalMaterial[]  tEditedMatl,
string[]  pMatlNames,
string  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

Property Documentation

Tag NXOpen.PhysicalMaterialCollection.Tag
get

Returns the tag of this object.


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