Loading...
Searching...
No Matches
IGeomParam.h
//-*****************************************************************************
//
// Copyright (c) 2009-2014,
// 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_IGeomParam_h
#define Alembic_AbcGeom_IGeomParam_h
#include <Alembic/AbcGeom/Foundation.h>
#include <Alembic/AbcGeom/GeometryScope.h>
namespace Alembic {
namespace AbcGeom {
namespace ALEMBIC_VERSION_NS {
//-*****************************************************************************
template <class TRAITS>
class ITypedGeomParam
{
public:
typedef typename TRAITS::value_type value_type;
typedef Abc::ITypedArrayProperty<TRAITS> prop_type;
class Sample
{
public:
typedef Sample this_type;
typedef Alembic::Util::shared_ptr< Abc::TypedArraySample<TRAITS> > samp_ptr_type;
Sample()
{}
Abc::UInt32ArraySamplePtr getIndices() const { return m_indices; }
samp_ptr_type getVals() const { return m_vals; }
GeometryScope getScope() const { return m_scope; }
bool isIndexed() const { return m_isIndexed; }
void reset()
{
m_vals.reset();
m_indices.reset();
m_scope = kUnknownScope;
m_isIndexed = false;
}
bool valid() const { return m_vals.get() != NULL; }
ALEMBIC_OPERATOR_BOOL( valid() );
protected:
friend class ITypedGeomParam<TRAITS>;
samp_ptr_type m_vals;
Abc::UInt32ArraySamplePtr m_indices;
GeometryScope m_scope;
bool m_isIndexed;
};
//-*************************************************************************
typedef ITypedGeomParam<TRAITS> this_type;
typedef typename this_type::Sample sample_type;
static const char * getInterpretation()
{
return TRAITS::interpretation();
}
static bool matches( const AbcA::PropertyHeader &iHeader,
SchemaInterpMatching iMatching = kStrictMatching )
{
if ( iHeader.isCompound() )
{
return ( iHeader.getMetaData().get( "podName" ) ==
Alembic::Util::PODName( TRAITS::dataType().getPod() ) &&
( std::string() == getInterpretation() ||
atoi(
iHeader.getMetaData().get( "podExtent" ).c_str() ) ==
TRAITS::dataType().getExtent() ) ) &&
prop_type::matches( iHeader.getMetaData(), iMatching );
}
else if ( iHeader.isArray() )
{
return prop_type::matches( iHeader, iMatching );
}
return false;
}
ITypedGeomParam() {m_isIndexed = false;}
template <class CPROP>
ITypedGeomParam( CPROP iParent,
const std::string &iName,
const Abc::Argument &iArg0 = Abc::Argument(),
const Abc::Argument &iArg1 = Abc::Argument() );
template <class PROP>
ITypedGeomParam( PROP iThis,
WrapExistingFlag iWrapFlag,
const Abc::Argument &iArg0 = Abc::Argument(),
const Abc::Argument &iArg1 = Abc::Argument() );
void getIndexed( sample_type &oSamp,
const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const;
void getExpanded( sample_type &oSamp,
const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const;
sample_type getIndexedValue( const Abc::ISampleSelector &iSS = \
Abc::ISampleSelector() ) const
{
sample_type ret;
getIndexed( ret, iSS );
return ret;
}
sample_type getExpandedValue( const Abc::ISampleSelector &iSS = \
Abc::ISampleSelector() ) const
{
sample_type ret;
getExpanded( ret, iSS );
return ret;
}
size_t getNumSamples() const;
AbcA::DataType getDataType() const { return TRAITS::dataType(); }
size_t getArrayExtent() const
{
std::string e = m_valProp.getMetaData().get( "arrayExtent" );
if ( e == "" ) { return 1; }
else { return atoi( e.c_str() ); }
}
bool isIndexed() const { return m_isIndexed; }
GeometryScope getScope() const
{ return GetGeometryScope( m_valProp.getMetaData() ); }
AbcA::TimeSamplingPtr getTimeSampling() const;
const std::string &getName() const;
Abc::ICompoundProperty getParent() const;
const AbcA::PropertyHeader &getHeader() const;
const AbcA::MetaData &getMetaData() const;
bool isConstant() const;
void reset()
{
m_valProp.reset();
m_indicesProperty.reset();
m_cprop.reset();
m_isIndexed = false;
}
bool valid() const
{
return ( m_valProp.valid()
&& ( ( ! m_cprop ) || m_indicesProperty ) );
}
ALEMBIC_OPERATOR_BOOL( this_type::valid() );
prop_type getValueProperty() { return m_valProp; }
Abc::IUInt32ArrayProperty getIndexProperty() { return m_indicesProperty; }
private:
Abc::ErrorHandler &getErrorHandler() const
{ return m_valProp.getErrorHandler(); }
protected:
prop_type m_valProp;
// if the GeomParam is not indexed, these will not exist.
Abc::IUInt32ArrayProperty m_indicesProperty;
Abc::ICompoundProperty m_cprop;
bool m_isIndexed;
};
//-*****************************************************************************
// TEMPLATED METHODS AND CONSTRUCTORS
//-*****************************************************************************
template <class TRAITS>
template <class CPROP>
ITypedGeomParam<TRAITS>::ITypedGeomParam( CPROP iParent,
const std::string &iName,
const Abc::Argument &iArg0,
const Abc::Argument &iArg1 )
{
Arguments args( GetErrorHandlerPolicy( iParent ) );
iArg0.setInto( args );
iArg1.setInto( args );
getErrorHandler().setPolicy( args.getErrorHandlerPolicy() );
ALEMBIC_ABC_SAFE_CALL_BEGIN( "ITypedGeomParam::ITypedGeomParam()" );
AbcA::CompoundPropertyReaderPtr parent =
GetCompoundPropertyReaderPtr( iParent );
ABCA_ASSERT( parent != NULL,
"NULL CompoundPropertyReader passed into "
<< "ITypedGeomParam ctor" );
const AbcA::PropertyHeader *pheader =
parent->getPropertyHeader( iName );
ABCA_ASSERT( pheader != NULL,
"Nonexistent GeomParam: " << iName );
if ( pheader->isCompound() )
{
// we're indexed
m_cprop = ICompoundProperty( iParent, iName,
args.getErrorHandlerPolicy() );
m_indicesProperty = IUInt32ArrayProperty( m_cprop, ".indices", iArg0,
iArg1 );
m_valProp = ITypedArrayProperty<TRAITS>( m_cprop, ".vals", iArg0,
iArg1 );
m_isIndexed = true;
}
else if ( pheader->isArray() )
{
// not indexed
m_valProp = ITypedArrayProperty<TRAITS>( iParent, iName, iArg0,
iArg1 );
m_isIndexed = false;
}
else
{
ABCA_ASSERT( false, "Invalid ITypedGeomParam: " << iName );
}
ALEMBIC_ABC_SAFE_CALL_END();
}
//-*****************************************************************************
template <class TRAITS>
template <class PROP>
ITypedGeomParam<TRAITS>::ITypedGeomParam( PROP iThis,
WrapExistingFlag iWrapFlag,
const Abc::Argument &iArg0,
const Abc::Argument &iArg1 )
{
Arguments args( GetErrorHandlerPolicy( iThis ) );
iArg0.setInto( args );
iArg1.setInto( args );
getErrorHandler().setPolicy( args.getErrorHandlerPolicy() );
ALEMBIC_ABC_SAFE_CALL_BEGIN( "ITypedGeomParam::ITypedGeomParam( wrap )" );
const AbcA::PropertyHeader &ph = iThis.getHeader();
ABCA_ASSERT( matches( ph,
Abc::GetSchemaInterpMatching( iArg0, iArg1 ) ),
"Property " << ph.getName() << " is not an "
<< "ITypedGeomParam" );
ABCA_ASSERT( ! ph.isScalar(), "Property " << ph.getName()
<< " cannot be an ITypedGeomParam" );
if ( ph.isCompound() )
{
// we're indexed
m_cprop = ICompoundProperty( iThis, iWrapFlag, iArg0, iArg1 );
m_indicesProperty = IUInt32ArrayProperty( m_cprop, ".indices", iArg0,
iArg1 );
m_valProp = ITypedArrayProperty<TRAITS>( m_cprop, ".vals", iArg0,
iArg1 );
m_isIndexed = true;
}
else
{
// not indexed
m_valProp = ITypedArrayProperty<TRAITS>( iThis, iWrapFlag, iArg0,
iArg1 );
m_isIndexed = false;
}
ALEMBIC_ABC_SAFE_CALL_END_RESET();
}
//-*****************************************************************************
template <class TRAITS>
void
ITypedGeomParam<TRAITS>::getIndexed( typename ITypedGeomParam<TRAITS>::Sample &oSamp,
const Abc::ISampleSelector &iSS ) const
{
m_valProp.get( oSamp.m_vals, iSS );
if ( m_indicesProperty ) { m_indicesProperty.get( oSamp.m_indices, iSS ); }
else
{
uint32_t size = static_cast< uint32_t > ( oSamp.m_vals->size() );
uint32_t *v = new uint32_t[size];
for ( uint32_t i = 0 ; i < size ; ++i )
{
v[i] = i;
}
const Alembic::Util::Dimensions dims( size );
oSamp.m_indices.reset( new Abc::UInt32ArraySample( v, dims ),
AbcA::TArrayDeleter<uint32_t>() );
}
oSamp.m_scope = this->getScope();
oSamp.m_isIndexed = m_isIndexed;
}
//-*****************************************************************************
template <class TRAITS>
void
ITypedGeomParam<TRAITS>::getExpanded( typename ITypedGeomParam<TRAITS>::Sample &oSamp,
const Abc::ISampleSelector &iSS ) const
{
oSamp.m_scope = this->getScope();
oSamp.m_isIndexed = m_isIndexed;
if ( ! m_indicesProperty )
{
m_valProp.get( oSamp.m_vals, iSS );
}
else
{
Abc::UInt32ArraySamplePtr idxPtr = m_indicesProperty.getValue( iSS );
size_t size = idxPtr->size();
// no indices? just return what we have in our values
if (size == 0)
{
m_valProp.get( oSamp.m_vals, iSS );
return;
}
Alembic::Util::shared_ptr< Abc::TypedArraySample<TRAITS> > valPtr = \
m_valProp.getValue( iSS );
typename TRAITS::value_type *v = new typename TRAITS::value_type[size];
for ( size_t i = 0 ; i < size ; ++i )
{
v[i] = (*valPtr)[ (*idxPtr)[i] ];
}
// NOTE: we could create an ArraySampleKey and insert this into the
// cache. If it were in the cache, we'd return the shared pointer
// from there and call delete[] on v, thus preventing potentially
// unbounded heap growth. We should probably do this, but for now,
// we'll assume that we don't have too many of these, and we're not
// tightly memory-constrained. Ha!
const Alembic::Util::Dimensions dims( size );
oSamp.m_vals.reset( new Abc::TypedArraySample<TRAITS>( v, dims ),
AbcA::TArrayDeleter<typename TRAITS::value_type>());
}
}
//-*****************************************************************************
template <class TRAITS>
size_t ITypedGeomParam<TRAITS>::getNumSamples() const
{
ALEMBIC_ABC_SAFE_CALL_BEGIN( "ITypedGeomParam::getNumSamples()" );
if ( m_isIndexed )
{
return std::max( m_indicesProperty.getNumSamples(),
m_valProp.getNumSamples() );
}
else
{
if ( m_valProp ) { return m_valProp.getNumSamples(); }
else { return 0; }
}
ALEMBIC_ABC_SAFE_CALL_END();
return 0;
}
//-*****************************************************************************
template <class TRAITS>
bool ITypedGeomParam<TRAITS>::isConstant() const
{
ALEMBIC_ABC_SAFE_CALL_BEGIN( "ITypedGeomParam::isConstant()" );
if ( m_isIndexed )
{
return m_valProp.isConstant() && m_indicesProperty.isConstant();
}
else
{
return m_valProp.isConstant();
}
ALEMBIC_ABC_SAFE_CALL_END();
return false;
}
namespace {
const std::string g_emptyStr;
}
//-*****************************************************************************
template <class TRAITS>
const std::string &ITypedGeomParam<TRAITS>::getName() const
{
ALEMBIC_ABC_SAFE_CALL_BEGIN( "ITypedGeomParam::getName()" );
if ( m_isIndexed ) { return m_cprop.getName(); }
else { return m_valProp.getName(); }
ALEMBIC_ABC_SAFE_CALL_END();
return g_emptyStr;
}
//-*****************************************************************************
template <class TRAITS>
Abc::ICompoundProperty ITypedGeomParam<TRAITS>::getParent() const
{
if ( m_isIndexed ) { return m_cprop.getParent(); }
else { return m_valProp.getParent(); }
}
//-*****************************************************************************
template <class TRAITS>
const AbcA::PropertyHeader &ITypedGeomParam<TRAITS>::getHeader() const
{
if ( m_isIndexed ) { return m_cprop.getHeader(); }
else { return m_valProp.getHeader(); }
}
//-*****************************************************************************
template <class TRAITS>
const AbcA::MetaData &ITypedGeomParam<TRAITS>::getMetaData() const
{
if ( m_isIndexed ) { return m_cprop.getMetaData(); }
else { return m_valProp.getMetaData(); }
}
//-*****************************************************************************
template <class TRAITS>
AbcA::TimeSamplingPtr ITypedGeomParam<TRAITS>::getTimeSampling() const
{
if ( m_valProp )
{
return m_valProp.getTimeSampling();
}
else if ( m_indicesProperty )
{
return m_indicesProperty.getTimeSampling();
}
return AbcA::TimeSamplingPtr();
}
//-*****************************************************************************
// TYPEDEFS
//-*****************************************************************************
typedef ITypedGeomParam<BooleanTPTraits> IBoolGeomParam;
typedef ITypedGeomParam<Uint8TPTraits> IUcharGeomParam;
typedef ITypedGeomParam<Int8TPTraits> ICharGeomParam;
typedef ITypedGeomParam<Uint16TPTraits> IUInt16GeomParam;
typedef ITypedGeomParam<Int16TPTraits> IInt16GeomParam;
typedef ITypedGeomParam<Uint32TPTraits> IUInt32GeomParam;
typedef ITypedGeomParam<Int32TPTraits> IInt32GeomParam;
typedef ITypedGeomParam<Uint64TPTraits> IUInt64GeomParam;
typedef ITypedGeomParam<Int64TPTraits> IInt64GeomParam;
typedef ITypedGeomParam<Float16TPTraits> IHalfGeomParam;
typedef ITypedGeomParam<Float32TPTraits> IFloatGeomParam;
typedef ITypedGeomParam<Float64TPTraits> IDoubleGeomParam;
typedef ITypedGeomParam<StringTPTraits> IStringGeomParam;
typedef ITypedGeomParam<WstringTPTraits> IWstringGeomParam;
typedef ITypedGeomParam<V2sTPTraits> IV2sGeomParam;
typedef ITypedGeomParam<V2iTPTraits> IV2iGeomParam;
typedef ITypedGeomParam<V2fTPTraits> IV2fGeomParam;
typedef ITypedGeomParam<V2dTPTraits> IV2dGeomParam;
typedef ITypedGeomParam<V3sTPTraits> IV3sGeomParam;
typedef ITypedGeomParam<V3iTPTraits> IV3iGeomParam;
typedef ITypedGeomParam<V3fTPTraits> IV3fGeomParam;
typedef ITypedGeomParam<V3dTPTraits> IV3dGeomParam;
typedef ITypedGeomParam<P2sTPTraits> IP2sGeomParam;
typedef ITypedGeomParam<P2iTPTraits> IP2iGeomParam;
typedef ITypedGeomParam<P2fTPTraits> IP2fGeomParam;
typedef ITypedGeomParam<P2dTPTraits> IP2dGeomParam;
typedef ITypedGeomParam<P3sTPTraits> IP3sGeomParam;
typedef ITypedGeomParam<P3iTPTraits> IP3iGeomParam;
typedef ITypedGeomParam<P3fTPTraits> IP3fGeomParam;
typedef ITypedGeomParam<P3dTPTraits> IP3dGeomParam;
typedef ITypedGeomParam<Box2sTPTraits> IBox2sGeomParam;
typedef ITypedGeomParam<Box2iTPTraits> IBox2iGeomParam;
typedef ITypedGeomParam<Box2fTPTraits> IBox2fGeomParam;
typedef ITypedGeomParam<Box2dTPTraits> IBox2dGeomParam;
typedef ITypedGeomParam<Box3sTPTraits> IBox3sGeomParam;
typedef ITypedGeomParam<Box3iTPTraits> IBox3iGeomParam;
typedef ITypedGeomParam<Box3fTPTraits> IBox3fGeomParam;
typedef ITypedGeomParam<Box3dTPTraits> IBox3dGeomParam;
typedef ITypedGeomParam<M33fTPTraits> IM33fGeomParam;
typedef ITypedGeomParam<M33dTPTraits> IM33dGeomParam;
typedef ITypedGeomParam<M44fTPTraits> IM44fGeomParam;
typedef ITypedGeomParam<M44dTPTraits> IM44dGeomParam;
typedef ITypedGeomParam<QuatfTPTraits> IQuatfGeomParam;
typedef ITypedGeomParam<QuatdTPTraits> IQuatdGeomParam;
typedef ITypedGeomParam<C3hTPTraits> IC3hGeomParam;
typedef ITypedGeomParam<C3fTPTraits> IC3fGeomParam;
typedef ITypedGeomParam<C3cTPTraits> IC3cGeomParam;
typedef ITypedGeomParam<C4hTPTraits> IC4hGeomParam;
typedef ITypedGeomParam<C4fTPTraits> IC4fGeomParam;
typedef ITypedGeomParam<C4cTPTraits> IC4cGeomParam;
typedef ITypedGeomParam<N2fTPTraits> IN2fGeomParam;
typedef ITypedGeomParam<N2dTPTraits> IN2dGeomParam;
typedef ITypedGeomParam<N3fTPTraits> IN3fGeomParam;
typedef ITypedGeomParam<N3dTPTraits> IN3dGeomParam;
} // End namespace ALEMBIC_VERSION_NS
using namespace ALEMBIC_VERSION_NS;
} // End namespace AbcGeom
} // End namespace Alembic
#endif
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::Arguments
Definition Argument.h:49
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT::reset
void reset()
Definition IBaseProperty.h:160
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
Definition ICompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector
Definition ISampleSelector.h:49
Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty
Definition ITypedArrayProperty.h:51
Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty::matches
static bool matches(const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
Definition ITypedArrayProperty.h:72
Alembic::Abc::ALEMBIC_VERSION_NS::TypedArraySample
Definition TypedArraySample.h:52
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam::Sample
Definition IGeomParam.h:56
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam
Definition IGeomParam.h:50
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39