ICompositeContainer.h

Go to the documentation of this file.

/********************************************************************
*
*   Project     Artec 3D Scanning SDK
*
*   Purpose:    Container for sequence of composite meshes
*
*   Copyright:  Artec Group
*
********************************************************************/
#ifndef _ICOMPOSITECONTAINER_H_
#define _ICOMPOSITECONTAINER_H_

#include <artec/sdk/base/Errors.h>
#include <artec/sdk/base/BaseSdkDefines.h>
#include <artec/sdk/base/IRef.h>
#include <artec/sdk/base/Matrix.h>

namespace artec { namespace sdk { namespace base
{

class IBlob;
class ICompositeMesh;
class ICompositeContainer;

extern "C"
{
    /**
    * Create new CompositeContainer
    * @param pContainer - destination CompositeContainer
    *
    * @return 
    *  error code
    */
    ErrorCode ABASESDK_LINK_SPEC createCompositeContainer(ICompositeContainer** pContainer);

    /**
    * clone all CompositeContainer content
    * @param out - destination CompositeContainer
    * @param in  - CompositeContainer to take elements from 
    *
    * @return 
    *  error code
    */
    ErrorCode ABASESDK_LINK_SPEC cloneCompositeContainer(ICompositeContainer* out, const ICompositeContainer* in);
}

class ICompositeContainer : public IRef
{
    /*
    *   This is a CompositeMesh container with transformation and some
    *   additional information on each surface
    */
public:
    // Element operations

    /// Element access. Index must be in range [0...getSize())
    virtual ICompositeMesh* getElement(int index) const = 0;
    virtual ErrorCode setElement(int index, ICompositeMesh* mesh) = 0;

    /// Add/remove composite mesh to container
    virtual ErrorCode add(ICompositeMesh* mesh) = 0;
    virtual ErrorCode add(ICompositeMesh* mesh, const Matrix4x4D& transformMatrix, IBlob* meshAttributes = NULL) = 0;
    virtual ErrorCode remove(int index) = 0;

    /// Access composite mesh orientation by index
    virtual const Matrix4x4D& getTransformation(int index) const = 0;
    virtual ErrorCode setTransformation(int index, const Matrix4x4D& transformMatrix) = 0;

    /// Get composite mesh attributes by index
    virtual IBlob* getAttributes(int index) const = 0;
    virtual ErrorCode setAttributes(int index, IBlob* attributes) = 0;
    
    
    // Container operations

    /// Get container transformation
    virtual const Matrix4x4D& getContainerTransformation() const = 0;
    virtual void setContainerTransformation(const Matrix4x4D& transformMatrix) = 0;

    /// Get container attributes by index
    virtual IBlob* getContainerAttributes() const = 0;
    virtual void setContainerAttributes(IBlob* attributes) = 0;


    // Container operations
    
    /// Get element number in container
    virtual int getSize() const = 0;

    /// Delete all container elements
    virtual void clear() = 0;
};

} } } // namespace artec::sdk::base

#endif // _IPOLYSCAN_H_