IModel.h

Go to the documentation of this file.

/********************************************************************
*
*   Project     Artec 3D Scanning SDK
*
*   Purpose:    Model (simple container for scans and composite meshes)
*
*   Copyright:  Artec Group
*
********************************************************************/
#ifndef _IMODEL_H_
#define _IMODEL_H_

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

namespace artec { namespace sdk { namespace base
{

class IScan;
class ICompositeContainer;
class IModel;

extern "C"
{
    /**
    * @brief Create new Model 
    * @param pContainer destination Model
    * @return   error code
    */
    ErrorCode ABASESDK_LINK_SPEC createModel(IModel** pContainer);

    /**
    * @brief create new Scans and CompositeContainer, but clone all content
    * @param out  destination Model
    * @param in   Model to take elements from 
    * @return     error code
    */
    ErrorCode ABASESDK_LINK_SPEC cloneModel(IModel* out,  const IModel* in);

    /**
    * @brief check for empty scan collection
    * @param in  Model to check
    * @return True if all IScan-s in the IModel are empty.
    */
    bool ABASESDK_LINK_SPEC allScansInModelEmpty(const IModel* in);

    /**
    * @brief check for empty CompositeContainer
    * @param in Model to check
    * @return True if CompositeContainer in the IModel is empty.
    */
    bool ABASESDK_LINK_SPEC isCompositeContainerInModelEmpty(const IModel* in);
}

/**
*   @brief This is a container of Scan(s) and a single CompositeContainer.
*   @details A newly created Model is empty and contains neither Scans nor CompositeContainer.
*/
class IModel : public IRef
{
public:
    /// Element operations

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

    /// Add/remove scan to/from container
    virtual ErrorCode add(const IScan* scan) = 0;
    virtual ErrorCode remove(int index) = 0;


    // Collection operations

    /// Retrieve compositemesh container
    virtual ICompositeContainer* getCompositeContainer() const = 0;

    /// Set compositemesh container
    virtual void setCompositeContainer(const ICompositeContainer* meshes) = 0;

    
    // Container operations

    /// Number of elements in collection
    virtual int getSize() const = 0;

    /// Clear collection
    virtual void clear() = 0;
};

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

#endif // _ISCANCOLLECTION_H_