//-*****************************************************************************

//

// Copyright (c) 2009-2012,

//  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_AbcGeom_OLight_h

#define Alembic_AbcGeom_OLight_h

#include <Alembic/Util/Export.h>

#include <Alembic/AbcGeom/OCamera.h>

#include <Alembic/AbcGeom/Foundation.h>

#include <Alembic/AbcGeom/SchemaInfoDeclarations.h>

namespace Alembic {

namespace AbcGeom {

namespace ALEMBIC_VERSION_NS {

//-*****************************************************************************

class ALEMBIC_EXPORT OLightSchema : public Abc::OSchema<LightSchemaInfo>

{

    //-*************************************************************************

    // LIGHT SCHEMA (just a container schema which has a camera schema)

    //-*************************************************************************

public:

    //! By convention we always define this_type in AbcGeom classes.

    //! Used by unspecified-bool-type conversion below

    typedef OLightSchema this_type;

    //-*************************************************************************

    // CONSTRUCTION, DESTRUCTION, ASSIGNMENT

    //-*************************************************************************

    //! The default constructor creates an empty OLightMeshSchema

    //! ...

    OLightSchema() {}

    //! This constructor creates a new light writer.

    //! The first argument is an CompoundPropertyWriterPtr to use as a parent.

    //! The next is the name to give the schema which is usually the default

    //! name given by OLight (.geom)   The remaining optional arguments

    //! can be used to override the ErrorHandlerPolicy, to specify

    //! MetaData, specify sparse sampling and to set TimeSampling.

    OLightSchema( AbcA::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() );

    //! This constructor creates a new light writer.

    //! The first argument is an OCompundProperty to use as a parent, and from

    //! which the ErrorHandlerPolicy is derived.  The next is the name to give

    //! the schema which is usually the default name given by OLight (.geom)

    //! The remaining optional arguments can be used to specify MetaData,

    //! specify sparse sampling and to set TimeSampling.

    OLightSchema( 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() );

    //! Default assignment and copy operator used.

    //-*************************************************************************

    // SCHEMA STUFF

    //-*************************************************************************

    //! Return the time sampling.

    AbcA::TimeSamplingPtr getTimeSampling() const { return m_tsPtr; }

    //-*************************************************************************

    // SAMPLE STUFF

    //-*************************************************************************

    //! All of our properties are not mandatory so we'll just use the

    //! child bounds.

    size_t getNumSamples();

    //! Set a sample

    void setCameraSample( const CameraSample &iSamp );

    //! Set from previous sample.

    void setFromPrevious();

    void setTimeSampling( uint32_t iIndex );

    void setTimeSampling( AbcA::TimeSamplingPtr iTime );

    Abc::OCompoundProperty getUserProperties();

    Abc::OCompoundProperty getArbGeomParams();

    Abc::OBox3dProperty getChildBoundsProperty();

    //-*************************************************************************

    // ABC BASE MECHANISMS

    // These functions are used by Abc to deal with errors, validity,

    // and so on.

    //-*************************************************************************

    //! Reset returns this function set to an empty, default

    //! state.

    void reset()

    {

        m_userProperties.reset();

        m_arbGeomParams.reset();

        m_cameraSchema.reset();

        m_childBoundsProperty.reset();

        Abc::OSchema<LightSchemaInfo>::reset();

    }

    //! Returns whether this function set is valid.

    bool valid() const

    {

        return ( Abc::OSchema<LightSchemaInfo>::valid() );

    }

    //! unspecified-bool-type operator overload.

    //! ...

    ALEMBIC_OVERRIDE_OPERATOR_BOOL( OLightSchema::valid() );

protected:

    void init( AbcA::CompoundPropertyWriterPtr iParent,

               const Abc::Argument &iArg0,

               const Abc::Argument &iArg1,

               const Abc::Argument &iArg2,

               const Abc::Argument &iArg3 );

    AbcA::TimeSamplingPtr m_tsPtr;

    Abc::OBox3dProperty m_childBoundsProperty;

    Abc::OCompoundProperty m_userProperties;

    Abc::OCompoundProperty m_arbGeomParams;

    AbcGeom::OCameraSchema m_cameraSchema;

};

//-*****************************************************************************

// SCHEMA OBJECT

//-*****************************************************************************

typedef Abc::OSchemaObject<OLightSchema> OLight;

typedef Util::shared_ptr< OLight > OLightPtr;

} // End namespace ALEMBIC_VERSION_NS

using namespace ALEMBIC_VERSION_NS;

} // End namespace AbcGeom

} // End namespace Alembic

#endif