2008-05-09 17:24:28 +00:00
|
|
|
/*
|
2008-05-22 10:20:31 +00:00
|
|
|
Open Asset Import Library (ASSIMP)
|
2008-05-09 17:24:28 +00:00
|
|
|
----------------------------------------------------------------------
|
|
|
|
|
|
|
|
Copyright (c) 2006-2008, ASSIMP Development Team
|
|
|
|
All rights reserved.
|
|
|
|
|
|
|
|
Redistribution and use of this software 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 the ASSIMP team, nor the names of its
|
|
|
|
contributors may be used to endorse or promote products
|
|
|
|
derived from this software without specific prior
|
|
|
|
written permission of the ASSIMP Development Team.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
----------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
|
2008-05-05 12:36:31 +00:00
|
|
|
/** @file Base class of all import post processing steps */
|
|
|
|
#ifndef AI_BASEPROCESS_H_INC
|
|
|
|
#define AI_BASEPROCESS_H_INC
|
|
|
|
|
2008-07-24 11:19:24 +00:00
|
|
|
|
|
|
|
#include "../include/aiTypes.h"
|
|
|
|
|
2008-05-05 12:36:31 +00:00
|
|
|
struct aiScene;
|
|
|
|
|
|
|
|
namespace Assimp
|
|
|
|
{
|
|
|
|
|
2008-08-13 23:46:46 +00:00
|
|
|
class Importer;
|
|
|
|
|
2008-05-05 12:36:31 +00:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
/** The BaseProcess defines a common interface for all post processing steps.
|
|
|
|
* A post processing step is run after a successful import if the caller
|
2008-08-08 18:34:14 +00:00
|
|
|
* specified the corresponding flag when calling ReadFile().
|
|
|
|
* Enum #aiPostProcessSteps defines which flags are available.
|
|
|
|
* After a successful import the Importer iterates over its internal array
|
|
|
|
* of processes and calls IsActive() on each process to evaluate if the step
|
|
|
|
* should be executed. If the function returns true, the class' Execute()
|
|
|
|
* function is called subsequently.
|
2008-05-05 12:36:31 +00:00
|
|
|
*/
|
2008-08-08 18:34:14 +00:00
|
|
|
class ASSIMP_API BaseProcess
|
2008-05-05 12:36:31 +00:00
|
|
|
{
|
|
|
|
friend class Importer;
|
|
|
|
|
2008-05-13 23:26:52 +00:00
|
|
|
public:
|
2008-08-08 18:34:14 +00:00
|
|
|
|
2008-05-05 12:36:31 +00:00
|
|
|
/** Constructor to be privately used by Importer */
|
|
|
|
BaseProcess();
|
|
|
|
|
|
|
|
/** Destructor, private as well */
|
|
|
|
virtual ~BaseProcess();
|
|
|
|
|
|
|
|
public:
|
2008-08-08 18:34:14 +00:00
|
|
|
|
2008-05-05 12:36:31 +00:00
|
|
|
// -------------------------------------------------------------------
|
2008-08-08 18:34:14 +00:00
|
|
|
/** Returns whether the processing step is present in the given flag.
|
|
|
|
* @param pFlags The processing flags the importer was called with. A
|
|
|
|
* bitwise combination of #aiPostProcessSteps.
|
|
|
|
* @return true if the process is present in this flag fields,
|
|
|
|
* false if not.
|
2008-05-05 12:36:31 +00:00
|
|
|
*/
|
|
|
|
virtual bool IsActive( unsigned int pFlags) const = 0;
|
|
|
|
|
|
|
|
// -------------------------------------------------------------------
|
|
|
|
/** Executes the post processing step on the given imported data.
|
2008-06-15 10:27:08 +00:00
|
|
|
* The function deletes the scene if the postprocess step fails (
|
|
|
|
* the object pointer will be set to NULL).
|
|
|
|
* @param pImp Importer instance (pImp->mScene must be valid)
|
|
|
|
*/
|
|
|
|
void ExecuteOnScene( Importer* pImp);
|
|
|
|
|
2008-08-08 18:34:14 +00:00
|
|
|
// -------------------------------------------------------------------
|
|
|
|
/** Called prior to ExecuteOnScene().
|
|
|
|
* The function is a request to the process to update its configuration
|
|
|
|
* basing on the Importer's configuration property list.
|
|
|
|
*/
|
|
|
|
virtual void SetupProperties(const Importer* pImp);
|
|
|
|
|
2008-06-15 10:27:08 +00:00
|
|
|
// -------------------------------------------------------------------
|
|
|
|
/** Executes the post processing step on the given imported data.
|
|
|
|
* A process should throw an ImportErrorException* if it fails.
|
|
|
|
* This method must be implemented by deriving classes.
|
2008-05-05 12:36:31 +00:00
|
|
|
* @param pScene The imported data to work at.
|
|
|
|
*/
|
|
|
|
virtual void Execute( aiScene* pScene) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
} // end of namespace Assimp
|
|
|
|
|
|
|
|
#endif // AI_BASEPROCESS_H_INC
|