Document.EnvironmentDocument Class Reference
#include
<class_document_1_1_environment_document.h>
Public Member Functions |
|
| __init__ () | |
| reset () | |
| setName () | |
| name () | |
| setId () | |
| id () | |
| setHome () | |
| home () | |
| setIsBackplate () | |
| isBackplate () | |
| updateIsBackplate () | |
| setIsEditable () | |
| isEditable () | |
| updateIsEditable () | |
| setIsLoaded () | |
| setIsModified () | |
| isModified () | |
| loadIsModified () | |
| saveIsModified () | |
| duplicate () | |
| Return the duplicated environment, here, we
need to copy each parameters to the new environment. |
|
| getOriginalCompanionDir () | |
| Returns the associated companion directory,
if it exists. |
|
| setShapeOverride () | |
| getShapeOverride () | |
| hasShapeOverride () | |
| setImageOverride () | |
| Sets the image parameter overrides. |
|
| getImageOverride () | |
| Returns the image overrides for this
environment. |
|
| setImage () | |
| image () | |
| Return environment image file. |
|
| updateImage () | |
| getMaterialOverrides () | |
| Returns a ValueParameterGroupRef containing
the parameters that have different values from the defaults.
|
|
| updateMaterials () | |
| Update the document materials with final
material. |
|
| getFinalMaterials () | |
| Returns the material for this environment.
|
|
| setMaterialOverrides () | |
| Set the override material for the document.
|
|
| setMaterialAssignmentOverride () | |
| getMaterialAssignmentOverride () | |
| updateMaterialAssignment () | |
| getFinalBackdropMaterialParameter () | |
| getBackdropOverride () | |
| Returns backdrop overrides. |
|
| setBackdropOverride () | |
| Sets backdrop overrides. |
|
| updateBackplateParameter () | |
| Update the backplate parametes directly.
|
|
| getFinalBackplateParameter () | |
| Returns the backplate parameters for this
environment. |
|
| getBackplateParamOverride () | |
| Returns the backplate parameter overrides.
|
|
| setBackplateParamOverride () | |
| Sets the backplate parameter overrides as
(fit type, scale, offset width, offset height) |
|
| getFinalBackdrop () | |
| Returns the backdrop for this environment.
|
|
| setLightingOverrides () | |
| Sets the lighting parameter overrides.
|
|
| getLightingOverrides () | |
| Returns the lighting overrides for this
environment. |
|
| getFinalLighting () | |
| Returns the lighting for this environment.
|
|
| updateLighting () | |
| Forces the update of the lighting. |
|
| updateMainLight () | |
| getMainLight () | |
| Returns the main light of this environment.
|
|
| applyLightAttributeOverrides () | |
| Given a ValueParameterGroup representing
overrides, applies these overrides to the environment light.
|
|
| setTransformationOverrides () | |
| Set the environment model's transformation
overrides. |
|
| getTransformationOverrides () | |
| Returns a dictionary containing the node id
and its transformation that have different values from the
defaults. |
|
| applyTransformationOverride () | |
| Apply the transformation override data to
the corresponding node. |
|
| resetOverrideData () | |
| Reset all the override data. |
|
| restoreLightAttributeDefaults () | |
| Restores all parameters if missingParamsOnly
is false, otherwise restores the missing parameters only. |
|
| getLightAttributeOverrides () | |
| Returns a ValueParameterGroup containing the
parameters that have different values from the defaults. |
|
| removeModel () | |
| Remove the model from the environment
document. |
|
| removeEnvironment () | |
| Remove all the nodes from the environment
document. |
|
| loadSubgraph () | |
| getSourceImage () | |
| getToneMappingExposure () | |
| setToneMappingExposure () | |
| hasOverrideData () | |
| getOriginalSourceImage () | |
| setOriginalSourceImage () | |
| setLinkRotation () | |
| getLinkRotation () | |
Public Attributes |
|
| string | kBackdropMaterialName = "Backdrop" |
| string | kBackdropParameterName = "diffuseTexture" |
| list | kBackdropMaterialParameters |
Member Function Documentation
| Document.EnvironmentDocument.__init__ | ( | ) |
Reimplemented from Document.Document.
| Document.EnvironmentDocument.reset | ( | ) |
Reimplemented from Document.FeatureMixin.
| Document.EnvironmentDocument.setName | ( | ) |
| Document.EnvironmentDocument.name | ( | ) |
| Document.EnvironmentDocument.setId | ( | ) |
| Document.EnvironmentDocument.id | ( | ) |
| Document.EnvironmentDocument.setHome | ( | ) |
| Document.EnvironmentDocument.home | ( | ) |
| Document.EnvironmentDocument.setIsBackplate | ( | ) |
| Document.EnvironmentDocument.isBackplate | ( | ) |
| Document.EnvironmentDocument.updateIsBackplate | ( | ) |
| Document.EnvironmentDocument.setIsEditable | ( | ) |
| Document.EnvironmentDocument.isEditable | ( | ) |
| Document.EnvironmentDocument.updateIsEditable | ( | ) |
| Document.EnvironmentDocument.setIsLoaded | ( | ) |
| Document.EnvironmentDocument.setIsModified | ( | ) |
| Document.EnvironmentDocument.isModified | ( | ) |
| Document.EnvironmentDocument.loadIsModified | ( | ) |
| Document.EnvironmentDocument.saveIsModified | ( | ) |
| Document.EnvironmentDocument.duplicate | ( | ) |
Return the duplicated environment, here, we need to copy each parameters to the new environment.
| Document.EnvironmentDocument.getOriginalCompanionDir | ( | ) |
Returns the associated companion directory, if it exists.
If it does not exist, then file's folder is returned. The companion directory is based on this document's original filename.
Reimplemented from Document.Document.
| Document.EnvironmentDocument.setShapeOverride | ( | ) |
| Document.EnvironmentDocument.getShapeOverride | ( | ) |
| Document.EnvironmentDocument.hasShapeOverride | ( | ) |
| Document.EnvironmentDocument.setImageOverride | ( | ) |
Sets the image parameter overrides.
| Document.EnvironmentDocument.getImageOverride | ( | ) |
Returns the image overrides for this environment.
| Document.EnvironmentDocument.setImage | ( | ) |
| Document.EnvironmentDocument.image | ( | ) |
Return environment image file.
| Document.EnvironmentDocument.updateImage | ( | ) |
| Document.EnvironmentDocument.getMaterialOverrides | ( | ) |
Returns a ValueParameterGroupRef containing the parameters that have different values from the defaults.
| Document.EnvironmentDocument.updateMaterials | ( | ) |
Update the document materials with final material.
| Document.EnvironmentDocument.getFinalMaterials | ( | ) |
Returns the material for this environment.
This includes any override material parameters that have been set. Note, if the original material or the overrides have been modified, ensure that updateMaterials() is called before calling this method.
| Document.EnvironmentDocument.setMaterialOverrides | ( | ) |
Set the override material for the document.
| Document.EnvironmentDocument.setMaterialAssignmentOverride | ( | ) |
| Document.EnvironmentDocument.getMaterialAssignmentOverride | ( | ) |
| Document.EnvironmentDocument.updateMaterialAssignment | ( | ) |
| Document.EnvironmentDocument.getFinalBackdropMaterialParameter | ( | ) |
| Document.EnvironmentDocument.getBackdropOverride | ( | ) |
Returns backdrop overrides.
| Document.EnvironmentDocument.setBackdropOverride | ( | ) |
Sets backdrop overrides.
| Document.EnvironmentDocument.updateBackplateParameter | ( | ) |
Update the backplate parametes directly.
| Document.EnvironmentDocument.getFinalBackplateParameter | ( | ) |
Returns the backplate parameters for this environment.
This includes the override backplate parameters that have been set.
| Document.EnvironmentDocument.getBackplateParamOverride | ( | ) |
Returns the backplate parameter overrides.
| Document.EnvironmentDocument.setBackplateParamOverride | ( | ) |
Sets the backplate parameter overrides as (fit type, scale, offset width, offset height)
| Document.EnvironmentDocument.getFinalBackdrop | ( | ) |
Returns the backdrop for this environment.
This includes the override backdrop image that have been set.
| Document.EnvironmentDocument.setLightingOverrides | ( | ) |
Sets the lighting parameter overrides.
| Document.EnvironmentDocument.getLightingOverrides | ( | ) |
Returns the lighting overrides for this environment.
| Document.EnvironmentDocument.getFinalLighting | ( | ) |
Returns the lighting for this environment.
This includes any override lighting parameters that have been set. Note, if the original lighting or the overrides have been modified, ensure that updateLighting() is called before calling this method.
| Document.EnvironmentDocument.updateLighting | ( | ) |
Forces the update of the lighting.
Call this when either the original lighting or the overrides have been modified.
| Document.EnvironmentDocument.updateMainLight | ( | ) |
| Document.EnvironmentDocument.getMainLight | ( | ) |
Returns the main light of this environment.
Returns None if no lights exist, unless 'forceCreation' is set to True, in which case, the light will be created and then returned.
| Document.EnvironmentDocument.applyLightAttributeOverrides | ( | ) |
Given a ValueParameterGroup representing overrides, applies these overrides to the environment light.
| Document.EnvironmentDocument.setTransformationOverrides | ( | ) |
Set the environment model's transformation overrides.
| Document.EnvironmentDocument.getTransformationOverrides | ( | ) |
Returns a dictionary containing the node id and its transformation that have different values from the defaults.
| Document.EnvironmentDocument.applyTransformationOverride | ( | ) |
Apply the transformation override data to the corresponding node.
| Document.EnvironmentDocument.resetOverrideData | ( | ) |
Reset all the override data.
| Document.EnvironmentDocument.restoreLightAttributeDefaults | ( | ) |
Restores all parameters if missingParamsOnly is false, otherwise restores the missing parameters only.
| Document.EnvironmentDocument.getLightAttributeOverrides | ( | ) |
Returns a ValueParameterGroup containing the parameters that have different values from the defaults.
| Document.EnvironmentDocument.removeModel | ( | ) |
Remove the model from the environment document.
It removes the import node as well as removes the corresponding modelImport. Note: There should be only one model per environment document.
| Document.EnvironmentDocument.removeEnvironment | ( | ) |
Remove all the nodes from the environment document.
It removes the import node, modelImport, light, etc.
| Document.EnvironmentDocument.loadSubgraph | ( | ) |
| Document.EnvironmentDocument.getSourceImage | ( | ) |
| Document.EnvironmentDocument.getToneMappingExposure | ( | ) |
| Document.EnvironmentDocument.setToneMappingExposure | ( | ) |
| Document.EnvironmentDocument.hasOverrideData | ( | ) |
| Document.EnvironmentDocument.getOriginalSourceImage | ( | ) |
| Document.EnvironmentDocument.setOriginalSourceImage | ( | ) |
| Document.EnvironmentDocument.setLinkRotation | ( | ) |
| Document.EnvironmentDocument.getLinkRotation | ( | ) |
Member Data Documentation
| string Document.EnvironmentDocument.kBackdropMaterialName = "Backdrop" |
| string Document.EnvironmentDocument.kBackdropParameterName = "diffuseTexture" |
[
( ParameterConstant.kBackplateMapping , Parameter.kString , ParameterConstant.kPlanar ),
( ParameterConstant.kBackplateHorizon , Parameter.kDouble , '0.0' ),
( ParameterConstant.kBackplateHorizontalOffset , Parameter.kDouble , '0.0' ),
( ParameterConstant.kBackplateRotation , Parameter.kDouble3 , '0.0 0.0 0.0' ),
( ParameterConstant.kBackplateCloseUp , Parameter.kDouble , '1.0' ),
( ParameterConstant.kBackplateSkyTexture , Parameter.kString , '' ),
( ParameterConstant.kBackplateSkyOffset , Parameter.kDouble , '0.0' )
]
