vrMaterialEntryId

class vrMaterialEntryId

Identifies an entry in the material tree. The material tree is formed out of the material pool by expanding all multimaterials as if they were regular nodes. Attention: When the tree structure is changed, this ID stays valid only for main material and group IDs. Submaterial IDs become invalid, if any of the parent materials are changed.

Functions

vrMaterialEntryId.getEntry()

Gets the associated entry.

Returns:The material tree entry.
Return type:vrMaterialEntry
vrMaterialEntryId.getEntryType()

Gets the type of the associated entry.

Returns:The type of the material tree entry.
Return type:vrMaterialEntryType
vrMaterialEntryId.getParentId()

Gets the parent, if this id is child of a group or a sub material.

Returns:The parent enty id.
Return type:vrMaterialEntryId
vrMaterialEntryId.vrMaterialEntryId()

Creates an invalid id.

vrMaterialEntryId.vrMaterialEntryId(groupNode)

Creates an ID for a material group.

Parameters:groupNode (vrdNode) – The node of the group.
vrMaterialEntryId.vrMaterialEntryId(materialNode)

Creates an ID for a main material.

Parameters:materialNode (vrdMaterialNode) – The node of the material.
vrMaterialEntryId.vrMaterialEntryId(parentId, childIndex)

Creates an ID for a submaterial.

Parameters:
  • parentId (vrMaterialEntryId) – The ID of the parent material.
  • childIndex (integer) – The child index of the submaterial within its parent.