Deprecated List

Member XSI::Application::ExecuteCommand (const CString &in_name, const CValueArray &in_args, CValue &io_val) const

3.5 This version is kept for backward compatibility, please use the new version instead.

Parameters:

	in_name	Command scripting name.
	in_args	Array of values containing the arguments to pass to the command. Because this argument is defined as const, the array cannot be updated with the output argument values returned by the command. You should use the other version of ExecuteCommand defined with a CValueArray& argument if you need to access the output argument values.
	io_val	The value returned by the command.

Returns:

CStatus::OK success

CStatus::Fail failure

Class CObjectAddedNotification

6.5. Please use the general siOnObjectAdded event instead.

Class CObjectRemovedNotification

6.5. Please use the general siOnObjectRemoved event instead.

Member XSI::Delta::AddOverrideFromPreset (const CString &in_Preset)

6.5. This method is obsolete and is maintained for informational purposes only. Use AddAction instead.

Note:

If there already an override in the delta, remove it before running this method.

Parameters:

in_Preset

Filename of preset

Returns:

CStatus::OK success

CStatus::Fail is returned in case of failure

Example:

Illustrates how to add an override property from a preset

        using namespace XSI;

        // Forward declaration
        void CreateOverridePreset ( const CString &in_presetFile, Application &in_App );

        Application app;

        // NewScene command
        CValueArray cargs; CValue oarg;
        cargs.Add( L"" ); cargs.Add( false );
        app.ExecuteCommand( L"NewScene", cargs, oarg );
        cargs.Clear();

        // Preset file path
        CString presetFile = app.GetInstallationPath( siUserPath) +
                        L"/Data/DSPresets/Properties/Override.Preset";

        // Create and save an override preset
        CreateOverridePreset(presetFile, app);

        //Add cube geometry and create the reference model
        Model root = app.GetActiveSceneRoot();
        X3DObject myCube, myCone;
        root.AddGeometry( L"Cube", L"MeshSurface",L"",myCube);

        // CreateModelAndConvertToRef command
        CString strFactPath = app.GetInstallationPath(siProjectPath) ;
            strFactPath += L"/Models/MyModel.emdl";
        cargs.Add( myCube.GetFullName() ); cargs.Add( strFactPath );
        app.ExecuteCommand( L"CreateModelAndConvertToRef", cargs, oarg );
        cargs.Clear();

        Delta myDelta;

        // AddDelta command
        cargs.Add( L"Model" );
        app.ExecuteCommand( L"AddDelta", cargs, oarg );
        cargs.Clear();

        // Add the override from preset
        myDelta = oarg;
        myDelta.AddOverrideFromPreset ( presetFile );

        //This function create the preset that is going to be add to the Delta
        void CreateOverridePreset ( const CString &in_presetFile, Application &in_App )
        {
            Model root = in_App.GetActiveSceneRoot();

            X3DObject myCube;
            root.AddGeometry( L"Cube", L"MeshSurface",L"",myCube);

            // CreateModelAndConvertToRef command
            CString strFactPath = in_App.GetInstallationPath(siProjectPath) ;
                strFactPath += L"/Models/MyModel.emdl";
            CValueArray cargs; CValue oarg;
            cargs.Add( myCube.GetFullName() ); cargs.Add( strFactPath );
            in_App.ExecuteCommand( L"CreateModelAndConvertToRef", cargs, oarg );
            cargs.Clear();

            // AddProp command
            cargs.Add( L"Synoptic Property" );
            cargs.Add( myCube.GetFullName() ); cargs.Add( L"" );
            in_App.ExecuteCommand( L"AddProp", cargs, oarg );
            cargs.Clear();

            // SetValue command
            cargs.Add( myCube.GetFullName() + L".Synoptic_Property.displayname"); cargs.Add( L"TestName" );
            in_App.ExecuteCommand( L"SetValue", cargs, oarg );
            cargs.Clear();

            // SavePreset command
            cargs.Add( L"Model.Delta.PropertiesAddedToRefModel" );
            cargs.Add( in_presetFile );
            in_App.ExecuteCommand( L"SavePreset", cargs, oarg );
            cargs.Clear();

            // NewScene command
            cargs.Add( L"" ); cargs.Add( false );
            in_App.ExecuteCommand( L"NewScene", cargs, oarg );
            cargs.Clear();

        }

Member XSI::Delta::RemoveOverride ()

6.5. This method is obsolete and is maintained for informational purposes only. Use RemoveAction instead.

Returns:

CStatus::OK success

CStatus::Fail is returned in case of failure

Example:

Illustrates how to remove override and action from the Delta.

        using namespace XSI;

        Application app;

        // NewScene command
        CValueArray cargs; CValue oarg;
        cargs.Add( L"" ); cargs.Add( false );
        app.ExecuteCommand( L"NewScene", cargs, oarg );
        cargs.Clear();

        //Add cube geometry and create the reference model
        Model root = app.GetActiveSceneRoot();
        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface",L"",myCube);

        // CreateModelAndConvertToRef command
        CString strFactPath = app.GetInstallationPath(siProjectPath) ;
            strFactPath += L"/Models/MyModel.emdl";
        cargs.Add( myCube.GetFullName() ); cargs.Add( strFactPath );
        app.ExecuteCommand( L"CreateModelAndConvertToRef", cargs, oarg );
        cargs.Clear();

        Delta myDelta;

        // AddDelta command
        cargs.Add( L"Model" );
        app.ExecuteCommand( L"AddDelta", cargs, oarg );
        cargs.Clear();
        myDelta = oarg;

        // Add an action of type siModificationDeltaStaticValue
        ActionDelta myDeltaAction = myDelta.AddAction(siModificationDeltaStaticValue);

        // Add the Static value item
        ActionDeltaItem myActionDeltaItem = myDeltaAction.AddStaticValueItem ( myCube.GetFullName()
                + L".kine.global.posx",  10.0);

        // AddProp command
        cargs.Add( L"Synoptic Property" );
        cargs.Add( myCube.GetFullName() ); cargs.Add( L"" );
        in_App.ExecuteCommand( L"AddProp", cargs, oarg );
        cargs.Clear();

        myDelta.RemoveOverride();
        myDelta.RemoveAction(siModificationDeltaStaticValue);


        // UpdateReferencedModel command
        cargs.Add( L"Model" );
        app.ExecuteCommand( L"UpdateReferencedModel", cargs, oarg );
        cargs.Clear();
        myDelta = oarg;

Member XSI::Geometry::SetupClosestLocationQueries (siClosestLocationMethod in_method=siClosestSurface, MATH::CTransformation *in_pTransfo=NULL, LONG in_nbFacetsToRestrictSearch=-1, const LONG *in_pFacetsToRestrictSearch=NULL)

6.0 Use the other overloaded version of this function where the argument in_nbLocatorsToBeQueried is present.

Class ImageClip

4.0 (but plug-ins using this class will continue to run in Softimage).

Member XSI::Menu::PutFilter (const CString &in_strFilter)

6.0 This method is required for backward compatibility, use MenuItem::Filter instead.

Member XSI::PortGroup::AddInputPort (const CRef &target, const CString &name=CString(), LONG insertat=-1, LONG flags=0, CStatus *pst=0)

5.1 This method is obsolete and must not be used. Use CustomOperator::AddInputPort instead.

Parameters:

	target	Object to be connected to the port.
	name	Port name.
	insertat	Port index within group.
	flags	Mask of input port flags described by siPortFlags.

Return values:

pst

The returned status code, returns CStatus::OK for success.

Returns:

A reference to the new InputPort.

Member XSI::PortGroup::AddOutputPort (const CRef &target, const CString &name=CString(), LONG insertat=-1, LONG flags=0, CStatus *pst=0)

5.1 This method is obsolete and must not be used. Use CustomOperator::AddOutputPort instead.

Parameters:

	target	Object to be connected to the port.
	name	Port name.
	insertat	Port index within group.
	flags	Mask of output port flags described by siPortFlags.

Return values:

pst

The returned status code, returns CStatus::OK for success.

Returns:

A reference to the new OutputPort.

Member XSI::PortGroup::AddIOPort (const CRef &target, const CString &name=CString(), LONG insertat=-1, LONG flags=0, CStatus *pst=0)

5.1 This method is obsolete and must not be used. Use CustomOperator::AddIOPort instead.

Parameters:

	target	Object to be connected to the port.
	name	Port name.
	insertat	Port index within group.
	flags	Mask of port flags described by siPortFlags.

Return values:

pst

The returned status code, returns CStatus::OK for success.

Returns:

Array of references to the new input and output ports.

Member XSI::SceneItem::AddProperty (const CString &in_preset, bool in_bBranch, const CString &in_name, Property &out_prop)

4.0 (but still maintained for backward compatibility)

Parameters:

	in_preset	The filename or full path to a Preset file.
	in_bBranch	True to apply property on the branch of object.
	in_name	The name of the new Property object.

Return values:

out_prop

The new Property object.

Member XSI::Shader::GetOutputType2 () const

7.0 Use Shader::GetShaderParameterType instead.

Member XSI::Shader::GetOutputType () const

5.0 Use Shader::GetShaderParameterType instead.

Member XSI::Shader::GetShaderInputType (const CString &in_scriptname) const

7.0 This function is obsolete and replaced by Shader::GetShaderParameterType that works with multi-output shaders.

Parameters:

in_scriptname

The script name of a parameter.

Returns:

The shader input type (one of the siShaderParameterType values). If the parameter cannot be connected to a shader, siUnknownParameterType is returned.

Since:

5.0