HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
homogeneous.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_BASE_GF_HOMOGENEOUS_H
25 #define PXR_BASE_GF_HOMOGENEOUS_H
26 
27 /// \file gf/homogeneous.h
28 /// \ingroup group_gf_LinearAlgebra
29 /// Utility functions for GfVec4f and GfVec4d as homogeneous vectors
30 
31 #include "pxr/pxr.h"
32 #include "pxr/base/gf/vec3d.h"
33 #include "pxr/base/gf/vec3f.h"
34 #include "pxr/base/gf/vec4d.h"
35 #include "pxr/base/gf/vec4f.h"
36 #include "pxr/base/gf/api.h"
37 
39 
40 /// Returns a vector which is \p v homogenized. If the fourth element of \p v
41 /// is 0, it is set to 1.
42 /// \ingroup group_gf_LinearAlgebra
43 GF_API
45 
46 /// Homogenizes \p a and \p b and then performs the cross product on the first
47 /// three elements of each. Returns the cross product as a homogenized
48 /// vector.
49 /// \ingroup group_gf_LinearAlgebra
50 GF_API
52 
53 GF_API
55 
56 /// Homogenizes \p a and \p b and then performs the cross product on the first
57 /// three elements of each. Returns the cross product as a homogenized
58 /// vector.
59 /// \ingroup group_gf_LinearAlgebra
60 GF_API
62 
63 /// Projects homogeneous \p v into Euclidean space and returns the result as a
64 /// Vec3f.
65 inline GfVec3f GfProject(const GfVec4f &v) {
66  float inv = (v[3] != 0.0f) ? 1.0f/v[3] : 1.0f;
67  return GfVec3f(inv * v[0], inv * v[1], inv * v[2]);
68 }
69 
70 /// Projects homogeneous \p v into Euclidean space and returns the result as a
71 /// Vec3d.
72 inline GfVec3d GfProject(const GfVec4d &v) {
73  double inv = (v[3] != 0.0) ? 1.0/v[3] : 1.0;
74  return GfVec3d(inv * v[0], inv * v[1], inv * v[2]);
75 }
76 
78 
79 #endif /* PXR_BASE_GF_HOMOGENEOUS_H */
GfVec3f GfProject(const GfVec4f &v)
Definition: homogeneous.h:65
PXR_NAMESPACE_OPEN_SCOPE GF_API GfVec4f GfGetHomogenized(const GfVec4f &v)
const GLdouble * v
Definition: glcorearb.h:837
Definition: vec3f.h:62
GLboolean GLboolean GLboolean GLboolean a
Definition: glcorearb.h:1222
Definition: vec4d.h:62
GLfloat f
Definition: glcorearb.h:1926
GLboolean GLboolean GLboolean b
Definition: glcorearb.h:1222
GF_API GfVec4f GfHomogeneousCross(const GfVec4f &a, const GfVec4f &b)
Definition: vec4f.h:62
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
Definition: vec3d.h:62
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
#define GF_API
Definition: api.h:40