Coin: SbPlane.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SbPlane.h
1#ifndef COIN_SBPLANE_H
2#define COIN_SBPLANE_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <cstdio>
37
38#include <Inventor/SbVec3f.h>
39
40class SbLine;
41class SbMatrix;
42
43 class COIN_DLL_API SbPlane {
44public:
45 SbPlane(void);
46 SbPlane(const SbVec3f& normal, const float D);
47 SbPlane(const SbVec3f& p0, const SbVec3f& p1, const SbVec3f& p2);
48 SbPlane(const SbVec3f& normal, const SbVec3f& point);
49
50 void offset(const float d);
51 SbBool intersect(const SbLine& l, SbVec3f& intersection) const;
52 void transform(const SbMatrix& matrix);
53 SbBool isInHalfSpace(const SbVec3f& point) const;
54 float getDistance(const SbVec3f &point) const;
55 const SbVec3f& getNormal(void) const;
56 float getDistanceFromOrigin(void) const;
57 friend COIN_DLL_API int operator ==(const SbPlane& p1, const SbPlane& p2);
58 friend COIN_DLL_API int operator !=(const SbPlane& p1, const SbPlane& p2);
59
60 void print(FILE * file) const;
61
62 SbBool intersect(const SbPlane & pl, SbLine & line) const;
63
64private:
65 SbVec3f normal;
66 float distance;
67};
68
69COIN_DLL_API int operator ==(const SbPlane& p1, const SbPlane& p2);
70COIN_DLL_API int operator !=(const SbPlane& p1, const SbPlane& p2);
71
72#endif // !COIN_SBPLANE_H
SbLine
The SbLine class represents a line in 3D space.
Definition SbLine.h:41
SbMatrix
The SbMatrix class is a 4x4 dimensional representation of a matrix.
Definition SbMatrix.h:47
SbPlane
The SbPlane class represents a plane in 3D space.
Definition SbPlane.h:43
SbPlane::print
void print(FILE *file) const
Definition SbPlane.cpp:378
SbPlane::intersect
SbBool intersect(const SbLine &l, SbVec3f &intersection) const
Definition SbPlane.cpp:163
SbPlane::SbPlane
SbPlane(void)
Definition SbPlane.cpp:61
SbPlane::getDistanceFromOrigin
float getDistanceFromOrigin(void) const
Definition SbPlane.cpp:280
SbPlane::offset
void offset(const float d)
Definition SbPlane.cpp:149
SbPlane::getDistance
float getDistance(const SbVec3f &point) const
Definition SbPlane.cpp:253
SbPlane::transform
void transform(const SbMatrix &matrix)
Definition SbPlane.cpp:214
SbPlane::isInHalfSpace
SbBool isInHalfSpace(const SbVec3f &point) const
Definition SbPlane.cpp:240
SbPlane::getNormal
const SbVec3f & getNormal(void) const
Definition SbPlane.cpp:268
SbVec3f
The SbVec3f class is a 3 dimensional vector with floating point coordinates.
Definition SbVec3f.h:51