OFaceSet.h

//-*****************************************************************************
//
// 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_OFaceSet_h
#define Alembic_AbcGeom_OFaceSet_h
 
#include <Alembic/Util/Export.h>
#include <Alembic/AbcGeom/Foundation.h>
#include <Alembic/AbcGeom/SchemaInfoDeclarations.h>
#include <Alembic/AbcGeom/OGeomParam.h>
#include <Alembic/AbcGeom/FaceSetExclusivity.h>
#include <Alembic/AbcGeom/OGeomBase.h>
 
namespace Alembic {
namespace AbcGeom {
namespace ALEMBIC_VERSION_NS {
 
//-*****************************************************************************
class ALEMBIC_EXPORT OFaceSetSchema : public OGeomBaseSchema<FaceSetSchemaInfo>
{
public:
    //-*************************************************************************
    // Parition SAMPLE
    //-*************************************************************************
    class Sample
    {
    public:
        typedef Sample this_type;

        Sample() { reset(); }

        Sample( const Abc::Int32ArraySample &iFaceNums)
          : m_faces( iFaceNums )
        {}
 
        /* main accessors */
        // Faces
        const Abc::Int32ArraySample &getFaces() const { return m_faces; }
        void setFaces( const Abc::Int32ArraySample &iFaces)
        { m_faces = iFaces; }
 
        // Bounding boxes
        const Abc::Box3d &getSelfBounds() const { return m_selfBounds; }
        void setSelfBounds( const Abc::Box3d &iBnds )
        { m_selfBounds = iBnds; }
 
        void reset()
        {
            m_faces.reset();
 
            m_selfBounds.makeEmpty();
        }
 
    protected:
        Abc::Int32ArraySample   m_faces;
 
        // bounds
        Abc::Box3d              m_selfBounds;
    }; // end OFaceSetSchema::Sample
 
 
    //-*************************************************************************
    // FaceSet SCHEMA
    //-*************************************************************************
public:
    typedef OFaceSetSchema this_type;
 
    //-*************************************************************************
    // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
    //-*************************************************************************
    OFaceSetSchema() {}

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

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

 
    //-*************************************************************************
    // SCHEMA STUFF
    //-*************************************************************************
 
    //-*************************************************************************
    // SAMPLE STUFF
    //-*************************************************************************

    size_t getNumSamples() const
    { return m_facesProperty.getNumSamples(); }

    void set( const Sample &iSamp );
 
    void setTimeSampling( uint32_t iTimeSamplingID );
    void setTimeSampling( AbcA::TimeSamplingPtr iTime );
 
    void setFaceExclusivity( FaceSetExclusivity iFacesExclusive );
    FaceSetExclusivity getFaceExclusivity() { return m_facesExclusive; }
    //-*************************************************************************
    // ABC BASE MECHANISMS
    // These functions are used by Abc to deal with errors, validity,
    // and so on.
    //-*************************************************************************

    void reset()
    {
        m_facesProperty.reset();
 
        OGeomBaseSchema<FaceSetSchemaInfo>::reset();
    }

    bool valid() const
    {
        return ( OGeomBaseSchema<FaceSetSchemaInfo>::valid() &&
                 m_facesProperty.valid()
                 );
    }

    ALEMBIC_OVERRIDE_OPERATOR_BOOL( OFaceSetSchema::valid() );
 
protected:
    void _recordExclusivityHint();
 
    void init( AbcA::CompoundPropertyWriterPtr iParent,
               const Abc::Argument &iArg0, const Abc::Argument &iArg1,
               const Abc::Argument &iArg2, const Abc::Argument &iArg3 );
 
    Abc::OInt32ArrayProperty    m_facesProperty;
 
    Abc::OUInt32Property        m_facesExclusiveProperty;
    FaceSetExclusivity          m_facesExclusive;
};
 
 
//-*****************************************************************************
// Nice to use typedef for users of this class.
//-*****************************************************************************
typedef Abc::OSchemaObject<OFaceSetSchema> OFaceSet;
 
typedef Util::shared_ptr< OFaceSet > OFaceSetPtr;
 
Abc::Box3d computeBoundsFromPositionsByFaces (const Int32ArraySample & faces,
    const Int32ArraySample & meshFaceCounts,
    const Int32ArraySample & vertexIndices,
    const P3fArraySample & meshP);
 
} // End namespace ALEMBIC_VERSION_NS
 
using namespace ALEMBIC_VERSION_NS;
 
} // End namespace AbcGeom
} // End namespace Alembic
 
#endif