/src/assimp/code/PostProcessing/RemoveVCProcess.h
Line | Count | Source |
1 | | /* |
2 | | Open Asset Import Library (assimp) |
3 | | ---------------------------------------------------------------------- |
4 | | |
5 | | Copyright (c) 2006-2025, assimp team |
6 | | |
7 | | All rights reserved. |
8 | | |
9 | | Redistribution and use of this software in source and binary forms, |
10 | | with or without modification, are permitted provided that the |
11 | | following conditions are met: |
12 | | |
13 | | * Redistributions of source code must retain the above |
14 | | copyright notice, this list of conditions and the |
15 | | following disclaimer. |
16 | | |
17 | | * Redistributions in binary form must reproduce the above |
18 | | copyright notice, this list of conditions and the |
19 | | following disclaimer in the documentation and/or other |
20 | | materials provided with the distribution. |
21 | | |
22 | | * Neither the name of the assimp team, nor the names of its |
23 | | contributors may be used to endorse or promote products |
24 | | derived from this software without specific prior |
25 | | written permission of the assimp team. |
26 | | |
27 | | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
28 | | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
29 | | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
30 | | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
31 | | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
32 | | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
33 | | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
34 | | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
35 | | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
36 | | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
37 | | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
38 | | |
39 | | ---------------------------------------------------------------------- |
40 | | */ |
41 | | |
42 | | /** @file Defines a post processing step to remove specific parts of the scene */ |
43 | | #ifndef AI_REMOVEVCPROCESS_H_INCLUDED |
44 | | #define AI_REMOVEVCPROCESS_H_INCLUDED |
45 | | |
46 | | #include "Common/BaseProcess.h" |
47 | | |
48 | | #include <assimp/mesh.h> |
49 | | |
50 | | class RemoveVCProcessTest; |
51 | | |
52 | | namespace Assimp { |
53 | | |
54 | | // --------------------------------------------------------------------------- |
55 | | /** RemoveVCProcess: Class to exclude specific parts of the data structure |
56 | | * from further processing by removing them, |
57 | | */ |
58 | | class ASSIMP_API RemoveVCProcess : public BaseProcess { |
59 | | public: |
60 | | // ------------------------------------------------------------------- |
61 | | /// The default class constructor / destructor. |
62 | | RemoveVCProcess(); |
63 | | ~RemoveVCProcess() override = default; |
64 | | |
65 | | // ------------------------------------------------------------------- |
66 | | /** Returns whether the processing step is present in the given flag field. |
67 | | * @param pFlags The processing flags the importer was called with. A bitwise |
68 | | * combination of #aiPostProcessSteps. |
69 | | * @return true if the process is present in this flag fields, false if not. |
70 | | */ |
71 | | bool IsActive( unsigned int pFlags) const override; |
72 | | |
73 | | // ------------------------------------------------------------------- |
74 | | /** Executes the post processing step on the given imported data. |
75 | | * At the moment a process is not supposed to fail. |
76 | | * @param pScene The imported data to work at. |
77 | | */ |
78 | | void Execute( aiScene* pScene) override; |
79 | | |
80 | | // ------------------------------------------------------------------- |
81 | | /** Called prior to ExecuteOnScene(). |
82 | | * The function is a request to the process to update its configuration |
83 | | * basing on the Importer's configuration property list. |
84 | | */ |
85 | | void SetupProperties(const Importer* pImp) override; |
86 | | |
87 | | // ------------------------------------------------------------------- |
88 | | /** Manually setup the configuration flags for the step |
89 | | * |
90 | | * @param Bitwise combination of the #aiComponent enumerated values. |
91 | | */ |
92 | 0 | void SetDeleteFlags(unsigned int f) { |
93 | 0 | configDeleteFlags = f; |
94 | 0 | } |
95 | | |
96 | | // ------------------------------------------------------------------- |
97 | | /** Query the current configuration. |
98 | | */ |
99 | 0 | unsigned int GetDeleteFlags() const { |
100 | 0 | return configDeleteFlags; |
101 | 0 | } |
102 | | |
103 | | private: |
104 | | |
105 | | bool ProcessMesh (aiMesh* pcMesh); |
106 | | |
107 | | /** Configuration flag |
108 | | */ |
109 | | unsigned int configDeleteFlags; |
110 | | |
111 | | /** The scene we're working with |
112 | | */ |
113 | | aiScene* mScene; |
114 | | }; |
115 | | |
116 | | // --------------------------------------------------------------------------- |
117 | | |
118 | | } // end of namespace Assimp |
119 | | |
120 | | #endif // !!AI_REMOVEVCPROCESS_H_INCLUDED |