SIGetOverriddenParameters
 
 
 

SIGetOverriddenParameters

Introduced

v6.5

Description

Returns the parameters affected by the specified override entry.

Scripting Syntax

oReturn = SIGetOverriddenParameters( Target );

Return Value

XSICollection containing each Parameter affected by this override entry.

Parameters

Parameter Type Description
Target String Override entry from which to return a list of affected parameters.

Examples

Python Example

# 
# This example demonstrates how to get a list of 
# overridden parameters under a Point light.
#
app = Application
app.NewScene(None, 0);
# Import the Softimage constants module
from win32com.client import constants as c
# Set up the scene
app.GetPrimLight("Point.Preset", "Point")
app.SetValue("Point.kine.local.pos.posx", 5);
app.SetValue("Point.light.soft_light.color.red", 0.3)
app.SetValue("Point.light.soft_light.color.green", 0.4)
app.SetValue("Point.light.soft_light.color.blue", 0.5)
app.SetKey("Point.kine.local.posx", 1, 5);
app.SetKey("Point.kine.local.posx", 100, 15);
# Override the values
app.AddProp("Override", "Point", c.siBranchPropagation);
app.SIAddParameterEntryToOverride("Point.Override", "Point.kine.local.pos.posx, Point.kine.local.pos.posy, Point.kine.local.pos.posz");
app.SIAddParameterEntryToOverride("Point.Override", "Point.light.soft_light.color");
# Set override values
app.SetValue("Point.Override.posx", -4);
app.SetValue("Point.Override.posx", -4);
app.SetKey("Point.Override.posx", 1, -4);
app.SetKey("Point.Override.posx", 100, 4);
app.CreateShaderFromProgID("Softimage.txt2d-image-explicit.1.0", "Point.light")
app.SIConnectShaderToCnxPoint("Point.light.Image.out", "Point.light.soft_light.color", False)
# Move the play control
app.SetValue("PlayControl.Key", 50);
app.SetValue("PlayControl.Current", 50);
overriddenParams = app.SIGetOverriddenParameters("Point.Override.Entries.entry");
for oParam in overriddenParams:
        # Get the unoverridden value
        val = app.SIGetOriginalValueOfOverridden(oParam);
        app.LogMessage("Original value   -> " + oParam.FullName + " -> " + str(val[0]));
        # Get the overridden value
        val = app.GetValue(oParam);
        app.LogMessage("Overridden value -> " + oParam.FullName + " -> " + str(val));
# Output:
# INFO : Original value   -> Point.kine.local.posx -> 9.92424500077
# INFO : Overridden value -> Point.kine.local.posx -> -0.0606039993858

See Also

SIGetOriginalValueOfOverridden