File: IObjHandler.h

package info (click to toggle)
lsp-plugins 1.2.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 91,856 kB
  • sloc: cpp: 427,831; xml: 57,779; makefile: 9,961; php: 1,005; sh: 18
file content (147 lines) | stat: -rw-r--r-- 5,615 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*
 * Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
 *           (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
 *
 * This file is part of lsp-runtime-lib
 * Created on: 21 апр. 2017 г.
 *
 * lsp-runtime-lib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * lsp-runtime-lib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with lsp-runtime-lib. If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef LSP_PLUG_IN_FMT_OBJ_IOBJHANDLER_H_
#define LSP_PLUG_IN_FMT_OBJ_IOBJHANDLER_H_

#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/runtime/LSPString.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/common/status.h>

#include <lsp-plug.in/fmt/obj/const.h>

namespace lsp
{
    namespace obj
    {
        /** File contents handler interface
         *
         */
        class IObjHandler
        {
            public:
                virtual ~IObjHandler();

            public:
                /** Start object
                 *
                 * @param id object id
                 * @param name object name
                 * @return status of operation
                 */
                virtual status_t begin_object(const char *name);

                /** Start object
                 *
                 * @param id object id
                 * @param name object name
                 * @return status of operation
                 */
                virtual status_t begin_object(const LSPString *name);

                /** End object
                 *
                 * @param id object id
                 * @return status of operation
                 */
                virtual status_t end_object();

                /**
                 * This callback is called when there is no more data at the input
                 * and allows to post-process/finalize loaded data structures
                 * @return status of operation
                 */
                virtual status_t end_of_data();

                /** Add vertex
                 *
                 * @param idx index
                 * @param x vertex X coordinate
                 * @param y vertex Y coordinate
                 * @param z vertex Z coordinate
                 * @param w vertex W coordinate
                 * @return number of added vertex or negative error code
                 */
                virtual ssize_t add_vertex(float x, float y, float z, float w);

                /** Add parameter vertex
                 *
                 * @param idx index
                 * @param x vertex X coordinate
                 * @param y vertex Y coordinate
                 * @param z vertex Z coordinate
                 * @param w vertex W coordinate
                 * @return number of added vertex or negative error code
                 */
                virtual ssize_t add_param_vertex(float x, float y, float z, float w);

                /** Add normal
                 *
                 * @param nx normal x
                 * @param ny normal y
                 * @param nz normal z
                 * @param nw normal w
                 * @return number of added normal or negative error code
                 */
                virtual ssize_t add_normal(float nx, float ny, float nz, float nw);

                /** Add texture vertex
                 *
                 * @param u texture U coordinate
                 * @param v texture V coordinate
                 * @param w texture W coordinate
                 * @return number of added texture vertex or negative error code
                 */
                virtual ssize_t add_texture_vertex(float u, float v, float w);

                /** Add face
                 *
                 * @param vv array of vertex indexes starting with 0 (negative value if not present)
                 * @param vn array of normal indexes starting with 0 (negative value if not present)
                 * @param vt array of texture vertex indexes starting with 0 (negative value if not present)
                 * @param n number of elements in vv, vn and vt
                 * @return status of operation
                 */
                virtual status_t add_face(const index_t *vv, const index_t *vn, const index_t *vt, size_t n);

                /** Add points
                 *
                 * @param vv array of vertex indexes starting with 1 (0 if not present)
                 * @param n number of elements in vv
                 * @return status of operation
                 */
                virtual status_t add_points(const index_t *vv, size_t n);

                /** Add line
                 *
                 * @param vv array of vertex indexes starting with 0 (negative value if not present)
                 * @param vt array of texture vertex indexes starting with 0 (negative value if not present)
                 * @param n number of elements in vv
                 * @return status of operation
                 */
                virtual status_t add_line(const index_t *vv, const index_t *vt, size_t n);
        };
    }

} /* namespace lsp */

#endif /* LSP_PLUG_IN_FMT_OBJ_IOBJHANDLER_H_ */