awScene.Appearance Class Reference
#include <classaw_scene_1_1_appearance.h>
Public Member Functions |
|
| __init__ () | |
| __init__ (Appearance that) | |
| str | getEffectKey (bool allLayers=True) |
| str | getOwnerType () |
| str | getOwnedObjectType () |
| MaterialRef | getMaterial () |
| setMaterial (MaterialRef material) | |
| MaterialRef | getTopMaterial () |
| Return the top-most (highest index) layer
material, or the base material if there are no layer materials.
|
|
| int | insertLayerMaterial (MaterialRef material, int index) |
| MaterialRef | getLayerMaterial (int index) |
| int | getLayerIndex (MaterialRef material) |
| int | deleteLayerMaterial (MaterialRef material) |
| int | getLayerMaterialCount () |
| int | clearLayerMaterials () |
| setLayerVisible (int index, bool isVisible) | |
| bool | isLayerVisible (int index) |
| ObjectAssociationsRef | getObjectAssociations () |
| setObjectAssociations (ObjectAssociationsRef) | |
| int | setLayerAssociations (ObjectAssociationsRef, int index) |
| ObjectAssociationsRef | getLayerAssociations (int index) |
| int | getLayerAssociationsIndex (ObjectAssociationsRef material) |
| ObjectPropertiesRef | getObjectProperties () |
| setObjectProperties (ObjectPropertiesRef properties) | |
| StylePropertiesRef | getStyleProperties () |
| setStyleProperties (StylePropertiesRef properties) | |
| int | setLayerStyleProperties (StylePropertiesRef, int index) |
| StylePropertiesRef | getLayerStyleProperties (int index) |
| LightingRef | getLighting () |
| setLighting (LightingRef lighting) | |
| LightingRef | getEnvironmentLighting () |
| setEnvironmentLighting (LightingRef lighting) | |
| bool | hasShadowing () |
| ShadowReceiverRef | getShadowing (str lightId) |
| ShadowReceiverRef | getEnvShadowing () |
| addShadowing (ShadowReceiverRef shadowing) | |
| removeShadowing (ShadowReceiverRef shadowing) | |
| resetShadowing () | |
| bool | operator== (Appearance that) |
| bool | operator!= (Appearance that) |
| Appearance | operator= (Appearance that) |
| awSupport ValueParameterGroupRef | getParameters () |
| Returns an unnamed ValueParameterGroup, with
the type of the material, that contains the parameters of the
object properties, material, environment light, environment IBL,
and lights. |
|
| awSupport ValueParameterGroupRef | getLayerParameters (int i) |
| bool | isValid () |
| bool | isOnlyStylistic () |
| setDrawState (DrawProperty property, bool state) | |
| bool | getDrawState (DrawProperty property) |
| setDrawStates (int drawStates) | |
| int | getDrawStates () |
| setStyleType (StyleType styleType, bool dirty) | |
| StyleType | getStyleType () |
| touch (bool notify=True) | |
| clearDirtyFlags () | |
| bool | isFlagDirty (DirtyFlag flag) |
| bool | forceObjectProperty (str objectPropertiesName, str objectPropertiesType, str propertyName, awSupport.Parameter.Type propertyType, str propertyValue) |
| Shortcuts to create object properties (if
not already there), create the parameter (if not already there) and
set its value. |
|
| bool | forceDrawPropertyD (str name, float value) |
| Shortcut for forcing a double "draw"
property. |
|
| bool | forceDrawPropertyS (str name, str value) |
| Shortcut for forcing a string "draw"
property. |
|
| bool | forceAssociationProperty (int index, str propertyName, awSupport.Parameter.Type propertyType, str propertyValue) |
| Shortcut for forcing association and a
matrix association. |
|
| bool | forceAssociationMatrixProperty (int index, str name, str value) |
| clearAssociationProperties (int index) | |
| Remove all association properties. |
|
| bool | addLight (str lightId, awSupport.ValueParameterGroupRef lightParms) |
| removeLight (str lightId) | |
| int | getNumLights () |
| awSupport ValueParameterGroupRef | getLight (str lightId) |
| LightIdToParameterGroupMap | getLightMap () |
| bool | addClipLight (str clipLightId, awSupport.ValueParameterGroupRef lightParms) |
| removeClipLight (str clipLightId) | |
| int | getNumClipLights () |
| setClipLightMap (LightIdToParameterGroupMap clipLightMap) | |
| awSupport ValueParameterGroupRef | getClipLight (str clipLightId) |
| LightIdToParameterGroupMap | getClipLightMap () |
Protected Member Functions |
|
| __del__ () | |
| onOwnedObjectDirty (awSupport.OwnedObject object) | |
| ObjectProperties | createObjectProperties (str name, str type) |
| str | getLayerKey (int layer) |
Member Function Documentation
| awScene.Appearance.__init__ | ( | ) |
| awScene.Appearance.__init__ | ( | Appearance | that | ) |
| str awScene.Appearance.getEffectKey | ( | bool | allLayers = True |
) |
| str awScene.Appearance.getOwnerType | ( | ) |
| str awScene.Appearance.getOwnedObjectType | ( | ) |
| MaterialRef awScene.Appearance.getMaterial | ( | ) |
| awScene.Appearance.setMaterial | ( | MaterialRef | material | ) |
| MaterialRef awScene.Appearance.getTopMaterial | ( | ) |
Return the top-most (highest index) layer material, or the base material if there are no layer materials.
| int awScene.Appearance.insertLayerMaterial | ( | MaterialRef | material, |
| int | index | ||
| ) |
| MaterialRef awScene.Appearance.getLayerMaterial | ( | int | index | ) |
| int awScene.Appearance.getLayerIndex | ( | MaterialRef | material | ) |
| int awScene.Appearance.deleteLayerMaterial | ( | MaterialRef | material | ) |
| int awScene.Appearance.getLayerMaterialCount | ( | ) |
| int awScene.Appearance.clearLayerMaterials | ( | ) |
| awScene.Appearance.setLayerVisible | ( | int | index, |
| bool | isVisible | ||
| ) |
| bool awScene.Appearance.isLayerVisible | ( | int | index | ) |
| ObjectAssociationsRef awScene.Appearance.getObjectAssociations | ( | ) |
| awScene.Appearance.setObjectAssociations | ( | ObjectAssociationsRef | ) |
| int awScene.Appearance.setLayerAssociations | ( | ObjectAssociationsRef | , |
| int | index | ||
| ) |
| ObjectAssociationsRef awScene.Appearance.getLayerAssociations | ( | int | index | ) |
| int awScene.Appearance.getLayerAssociationsIndex | ( | ObjectAssociationsRef | material | ) |
| ObjectPropertiesRef awScene.Appearance.getObjectProperties | ( | ) |
| awScene.Appearance.setObjectProperties | ( | ObjectPropertiesRef | properties | ) |
| StylePropertiesRef awScene.Appearance.getStyleProperties | ( | ) |
| awScene.Appearance.setStyleProperties | ( | StylePropertiesRef | properties | ) |
| int awScene.Appearance.setLayerStyleProperties | ( | StylePropertiesRef | , |
| int | index | ||
| ) |
| StylePropertiesRef awScene.Appearance.getLayerStyleProperties | ( | int | index | ) |
| LightingRef awScene.Appearance.getLighting | ( | ) |
| awScene.Appearance.setLighting | ( | LightingRef | lighting | ) |
| LightingRef awScene.Appearance.getEnvironmentLighting | ( | ) |
| awScene.Appearance.setEnvironmentLighting | ( | LightingRef | lighting | ) |
| bool awScene.Appearance.hasShadowing | ( | ) |
| ShadowReceiverRef awScene.Appearance.getShadowing | ( | str | lightId | ) |
| ShadowReceiverRef awScene.Appearance.getEnvShadowing | ( | ) |
| awScene.Appearance.addShadowing | ( | ShadowReceiverRef | shadowing | ) |
| awScene.Appearance.removeShadowing | ( | ShadowReceiverRef | shadowing | ) |
| awScene.Appearance.resetShadowing | ( | ) |
| bool awScene.Appearance.operator== | ( | Appearance | that | ) |
| bool awScene.Appearance.operator!= | ( | Appearance | that | ) |
| Appearance awScene.Appearance.operator= | ( | Appearance | that | ) |
| awSupport ValueParameterGroupRef awScene.Appearance.getParameters | ( | ) |
Returns an unnamed ValueParameterGroup, with the type of the material, that contains the parameters of the object properties, material, environment light, environment IBL, and lights.
If a parameter exists on more than one of these, the first one is taken, in the order specified above. This ValueParameterGroup is constructed explicitly in this call and does not correspond to one of the groups being held by this class.
The second version is the same as the first, except that the parameters are considered from the layer material at the given index.
| awSupport ValueParameterGroupRef awScene.Appearance.getLayerParameters | ( | int | i | ) |
| bool awScene.Appearance.isValid | ( | ) |
| bool awScene.Appearance.isOnlyStylistic | ( | ) |
| awScene.Appearance.setDrawState | ( | DrawProperty | property, |
| bool | state | ||
| ) |
| bool awScene.Appearance.getDrawState | ( | DrawProperty | property | ) |
| awScene.Appearance.setDrawStates | ( | int | drawStates | ) |
| int awScene.Appearance.getDrawStates | ( | ) |
| awScene.Appearance.setStyleType | ( | StyleType | styleType, |
| bool | dirty | ||
| ) |
| StyleType awScene.Appearance.getStyleType | ( | ) |
| awScene.Appearance.touch | ( | bool | notify = True |
) |
| awScene.Appearance.clearDirtyFlags | ( | ) |
| bool awScene.Appearance.isFlagDirty | ( | DirtyFlag | flag | ) |
| bool awScene.Appearance.forceObjectProperty | ( | str | objectPropertiesName, |
| str | objectPropertiesType, | ||
| str | propertyName, | ||
| awSupport.Parameter.Type | propertyType, | ||
| str | propertyValue | ||
| ) |
Shortcuts to create object properties (if not already there), create the parameter (if not already there) and set its value.
Return true if the object properties had to be created, false if it just had to be edited.
| bool awScene.Appearance.forceDrawPropertyD | ( | str | name, |
| float | value | ||
| ) |
Shortcut for forcing a double "draw" property.
| bool awScene.Appearance.forceDrawPropertyS | ( | str | name, |
| str | value | ||
| ) |
Shortcut for forcing a string "draw" property.
| bool awScene.Appearance.forceAssociationProperty | ( | int | index, |
| str | propertyName, | ||
| awSupport.Parameter.Type | propertyType, | ||
| str | propertyValue | ||
| ) |
Shortcut for forcing association and a matrix association.
If index is -1, put it on the main material, otherwise on the layer.
| bool awScene.Appearance.forceAssociationMatrixProperty | ( | int | index, |
| str | name, | ||
| str | value | ||
| ) |
| awScene.Appearance.clearAssociationProperties | ( | int | index | ) |
Remove all association properties.
-1 for object, otherwise index for layered association
| bool awScene.Appearance.addLight | ( | str | lightId, |
| awSupport.ValueParameterGroupRef | lightParms | ||
| ) |
| awScene.Appearance.removeLight | ( | str | lightId | ) |
| int awScene.Appearance.getNumLights | ( | ) |
| awSupport ValueParameterGroupRef awScene.Appearance.getLight | ( | str | lightId | ) |
| LightIdToParameterGroupMap awScene.Appearance.getLightMap | ( | ) |
| bool awScene.Appearance.addClipLight | ( | str | clipLightId, |
| awSupport.ValueParameterGroupRef | lightParms | ||
| ) |
| awScene.Appearance.removeClipLight | ( | str | clipLightId | ) |
| int awScene.Appearance.getNumClipLights | ( | ) |
| awScene.Appearance.setClipLightMap | ( | LightIdToParameterGroupMap | clipLightMap | ) |
| awSupport ValueParameterGroupRef awScene.Appearance.getClipLight | ( | str | clipLightId | ) |
| LightIdToParameterGroupMap awScene.Appearance.getClipLightMap | ( | ) |
| awScene.Appearance.__del__ | ( | ) | [protected] |
| awScene.Appearance.onOwnedObjectDirty | ( | awSupport.OwnedObject | object | ) | [protected] |
| ObjectProperties awScene.Appearance.createObjectProperties | ( | str | name, |
| str | type | ||
| ) | [protected] |
| str awScene.Appearance.getLayerKey | ( | int | layer | ) | [protected] |
