vrdMaterial¶
-
class
vrdMaterial¶
(Inherits vrdSceneObject)
Base class for all materials.
Summary¶
- Functions:
- compressTextures()
- duplicate(name) → vrdMaterial
- getIcon() → QIcon
- getLocked() → bool
- getName() → string
- getPreview() → QImage
- getPreviewScene() → string
- getTextures() → List[vrdTexture]
- isAsset() → bool
- isComponent() → bool
- isEditable() → bool
- isEditedAsset() → bool
- setInlineAllImageSequences(value) → List[vrdImage]
- setLocked(locked)
- setName(name)
- setPreviewScene(name)
Functions¶
-
vrdMaterial.compressTextures()¶ Compresses all textures in this material.
-
vrdMaterial.duplicate(name='')¶ Creates a duplicate of this material.
Parameters: name (string) – The name of the new material. If empty, a unique name is generated Returns: The newly created material Return type: vrdMaterial
-
vrdMaterial.getIcon()¶ Returns: Material type icon Return type: QIcon
-
vrdMaterial.getLocked()¶ Returns: Returns True, if the material is locked Return type: bool
-
vrdMaterial.getName()¶ Returns the name of the material.
Returns: The name of the material. Return type: string
-
vrdMaterial.getPreview()¶ Returns: Preview image of this material Return type: QImage
-
vrdMaterial.getPreviewScene()¶ Returns: Returns The currently selected preview scene Return type: string
-
vrdMaterial.getTextures()¶ Returns: A list of all available texture objects in this material Return type: List[vrdTexture]
-
vrdMaterial.isAsset()¶ Returns: True, if material is linked the asset manager Return type: bool
-
vrdMaterial.isComponent()¶ Some materials can only exist as a component of other materials.
Returns: True, if this is a component material. E.g. an XRite child material Return type: bool
-
vrdMaterial.isEditable()¶ Returns: True, if material is not locked and is not an unedited asset Return type: bool
-
vrdMaterial.isEditedAsset()¶ Returns: True, if this is an edited asset. Return type: bool
-
vrdMaterial.setInlineAllImageSequences(value)¶ Inlines (embeds) all image sequences of this material in the project file, or removes embedded image sequence data from project.
Parameters: value (bool) – True to inline, False to remove inlined image sequence data. Returns: A list of all changed images Return type: List[vrdImage]
-
vrdMaterial.setLocked(locked)¶ Locks this material.
Parameters: locked (bool) – If true, material is locked.
-
vrdMaterial.setName(name)¶ Sets the name of the material.
Parameters: name (string) – The new name of the material.
-
vrdMaterial.setPreviewScene(name)¶ Selects the scene used for preview images.
Parameters: name (string) – Name of the preview scene