Tissue Forge C 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
tfCClipPlane.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of Tissue Forge.
3 * Copyright (c) 2022-2024 T.J. Sego
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License as published
7 * by the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
18 ******************************************************************************/
19
25#ifndef _WRAPS_C_TFCCLIPPLANE_H_
26#define _WRAPS_C_TFCCLIPPLANE_H_
27
28#include "tf_port_c.h"
29
30// Handles
31
36struct CAPI_EXPORT tfRenderingClipPlaneHandle {
37 void *tfObj;
38};
39
40
42// rendering::ClipPlane //
44
45
53CAPI_FUNC(HRESULT) tfRenderingClipPlane_getIndex(struct tfRenderingClipPlaneHandle *handle, int *index);
54
62CAPI_FUNC(HRESULT) tfRenderingClipPlane_getPoint(struct tfRenderingClipPlaneHandle *handle, float **point);
63
71CAPI_FUNC(HRESULT) tfRenderingClipPlane_getNormal(struct tfRenderingClipPlaneHandle *handle, float **normal);
72
80CAPI_FUNC(HRESULT) tfRenderingClipPlane_getEquation(struct tfRenderingClipPlaneHandle *handle, float **pe);
81
89CAPI_FUNC(HRESULT) tfRenderingClipPlane_setEquationE(struct tfRenderingClipPlaneHandle *handle, float *pe);
90
100CAPI_FUNC(HRESULT) tfRenderingClipPlane_setEquationPN(struct tfRenderingClipPlaneHandle *handle, float *point, float *normal);
101
109
117
118
120// Module functions //
122
123
130CAPI_FUNC(HRESULT) tfRenderingClipPlanes_len(unsigned int *numCPs);
131
139CAPI_FUNC(HRESULT) tfRenderingClipPlanes_item(struct tfRenderingClipPlaneHandle *handle, unsigned int index);
140
148CAPI_FUNC(HRESULT) tfRenderingClipPlanes_createE(struct tfRenderingClipPlaneHandle *handle, float *pe);
149
158CAPI_FUNC(HRESULT) tfRenderingClipPlanes_createPN(struct tfRenderingClipPlaneHandle *handle, float *point, float *normal);
159
160#endif // _WRAPS_C_TFCCLIPPLANE_H_
Handle to a rendering::ClipPlane instance.
Definition tfCClipPlane.h:36
HRESULT tfRenderingClipPlane_getPoint(struct tfRenderingClipPlaneHandle *handle, float **point)
Get the point of the clip plane.
HRESULT tfRenderingClipPlane_getIndex(struct tfRenderingClipPlaneHandle *handle, int *index)
Get the index of the clip plane.
HRESULT tfRenderingClipPlane_setEquationPN(struct tfRenderingClipPlaneHandle *handle, float *point, float *normal)
Set the coefficients of the plane equation of the clip plane using a point on the plane and its norma...
HRESULT tfRenderingClipPlanes_len(unsigned int *numCPs)
Get the number of clip planes.
HRESULT tfRenderingClipPlanes_createPN(struct tfRenderingClipPlaneHandle *handle, float *point, float *normal)
Create a clip plane from a point and normal of the plane.
HRESULT tfRenderingClipPlane_setEquationE(struct tfRenderingClipPlaneHandle *handle, float *pe)
Set the coefficients of the plane equation of the clip plane.
HRESULT tfRenderingClipPlane_destroy(struct tfRenderingClipPlaneHandle *handle)
Destroy the handle instance.
HRESULT tfRenderingClipPlane_getNormal(struct tfRenderingClipPlaneHandle *handle, float **normal)
Get the normal vector of the clip plane.
HRESULT tfRenderingClipPlane_destroyCP(struct tfRenderingClipPlaneHandle *handle)
Destroy the clip plane.
HRESULT tfRenderingClipPlanes_createE(struct tfRenderingClipPlaneHandle *handle, float *pe)
Create a clip plane from the coefficients of the equation of the plane.
HRESULT tfRenderingClipPlane_getEquation(struct tfRenderingClipPlaneHandle *handle, float **pe)
Get the coefficients of the plane equation of the clip plane.
HRESULT tfRenderingClipPlanes_item(struct tfRenderingClipPlaneHandle *handle, unsigned int index)
Get a clip plane by index.