OMaterial.h

Go to the documentation of this file.

//-*****************************************************************************
//
// Copyright (c) 2009-2015,
//  Sony Pictures Imageworks Inc. and
//  Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// *       Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// *       Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// *       Neither the name of Sony Pictures Imageworks, nor
// Industrial Light & Magic, nor the names of their contributors may be used
// to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//-*****************************************************************************

#ifndef Alembic_AbcMaterial_OMaterial_h
#define Alembic_AbcMaterial_OMaterial_h

#include <Alembic/Abc/All.h>

#include <Alembic/Util/Export.h>
#include <Alembic/AbcMaterial/SchemaInfoDeclarations.h>

namespace Alembic {
namespace AbcMaterial {
namespace ALEMBIC_VERSION_NS {

//! Schema for writing shader definitions as either an object or
//! a compound property.
//! Only "monolithic" shader definitions (i.e. non network) are presently
//! supported in this implementation.
class ALEMBIC_EXPORT OMaterialSchema
    : public Abc::OSchema<MaterialSchemaInfo>
{
public:

    //-------------------------------------------------------------------------
    //BOILERPLATE

    typedef OMaterialSchema this_type;

    OMaterialSchema() {}

    OMaterialSchema(
        Alembic::AbcCoreAbstract::CompoundPropertyWriterPtr iParent,
        const std::string &iName,
        const Abc::Argument &iArg0 = Abc::Argument(),
        const Abc::Argument &iArg1 = Abc::Argument(),
        const Abc::Argument &iArg2 = Abc::Argument(),
        const Abc::Argument &iArg3 = Abc::Argument() );

    OMaterialSchema( Abc::OCompoundProperty iParent,
                     const std::string &iName,
                     const Abc::Argument &iArg0 = Abc::Argument(),
                     const Abc::Argument &iArg1 = Abc::Argument(),
                     const Abc::Argument &iArg2 = Abc::Argument() );

    //! Copy constructor.
    OMaterialSchema( const OMaterialSchema& iCopy )
    : Abc::OSchema<MaterialSchemaInfo>()
    {
        *this = iCopy;
    }

    //-------------------------------------------------------------------------
    //ACTUAL STUFF

    //! Declare shader for a given target and shaderType.
    //! "Target's" value is an agreed upon convention for a renderer
    //! or application (i.e. "prman")
    //! "ShaderType's" value is an agreed upon convention for shader terminals
    //! such as "surface," "displacement," "light", "coshader_somename."
    //! "ShaderName's" value is an identifier meaningful to the target
    //! application (i.e. "paintedplastic," "fancy_spot_light").
    //! It's only valid to call this once per target/shaderType combo.
    void setShader( const std::string & iTarget,
                    const std::string & iShaderType,
                    const std::string & iShaderName );

    //! Declare and retrieve a container for storing properties representing
    //! parameters for the target and shaderType. You put them in there
    //! yourself since there are no restrictions on type or sampling other
    //! than what's appropriate and meaningful for the target application.
    //! Repeated calls will return the same object.
    Abc::OCompoundProperty getShaderParameters(
        const std::string & iTarget, const std::string & iShaderType );

    //add node by name, target, type, set node connection?, set node
    //terminals?

    void addNetworkNode( const std::string & iNodeName,
                         const std::string & iTarget,
                         const std::string & iNodeType );

    void setNetworkNodeConnection( const std::string & iNodeName,
                                   const std::string & iInputName,
                                   const std::string & iConnectedNodeName,
                                   const std::string & iConnectedOutputName );

    Abc::OCompoundProperty
    getNetworkNodeParameters( const std::string & iNodeName );

    void setNetworkTerminal( const std::string & iTarget,
                             const std::string & iShaderType,
                             const std::string & iNodeName,
                             const std::string & iOutputName = "" );

    void
    setNetworkInterfaceParameterMapping(
        const std::string & iInterfaceParamName,
        const std::string & iMapToNodeName,
        const std::string & iMapToParamName );

    Abc::OCompoundProperty getNetworkInterfaceParameters();

protected:

    void init();

    // all the network nodes will be placed under this property
    Abc::OCompoundProperty m_node;
    void createNodeCompound();

    class Data;

    // shared and not scoped because we want this to survive a copy
    Util::shared_ptr< Data > m_data;
};

//! Object declaration
typedef Abc::OSchemaObject<OMaterialSchema> OMaterial;

typedef Util::shared_ptr< OMaterial > OMaterialPtr;

} // End namespace ALEMBIC_VERSION_NS

using namespace ALEMBIC_VERSION_NS;

} // End namespace AbcMaterial
} // End namespace Alembic


#endif