Method ToString

ToString()

Returns string representation of the finishes config.

Declaration

public override string ToString()

Returns

Type	Description
string	See FinishesConfigString documentation for the description of the string format.

Overrides

object.ToString()

Examples

The following example shows how to manipulate an object's finishes config using the Scene.FinishesConfig class.

public void SetFrontColourToWhiteIfAvailable(Scene.Object obj)
{
    // This methods sets front colour of given object to white, if such
    // an option is available.

    // Let's parse object's finishes config string to access individual
    // finishes and types.
    var finishesConfig = new Scene.FinishesConfig(obj, obj.FinishesConfigString);

    // Now let's find "Front colour" finish type.
    Appli.CatalogFinishType frontColorFinishType;

    if(!finishesConfig.TryGetFinishTypeByName("Front Colour",
            out frontColorFinishType))
    {
        // This object doesn't utilize "Front colour" finish type.
        return;
    }

    // Now let's find "white" finish in the finish type.
    Appli.CatalogFinish whiteFrontColor;

    if(!frontColorFinishType.TryGetFinishByName("white", 
        out whiteFrontColor))
    {
        // This object doesn't have "white" front color option.
        return;
    }

    // Let's set white front colour to the finishes config.
    finishesConfig[frontColorFinishType] = whiteFrontColor;

    // And now let's assign the result back to the object to apply the
    // result.
    obj.FinishesConfigString = finishesConfig.ToString();
}