NVIDIA IndeX API nvidia_logo_transpbg.gif Up
iplane.h
Go to the documentation of this file.
1/******************************************************************************
2 * Copyright 2023 NVIDIA Corporation. All rights reserved.
3 *****************************************************************************/
6
7#ifndef NVIDIA_INDEX_IPLANE_H
8#define NVIDIA_INDEX_IPLANE_H
9
10#include <mi/dice.h>
11#include <mi/base/interface_declare.h>
12
13#include <nv/index/ishape.h>
14
15namespace nv
16{
17namespace index
18{
19
34class IPlane :
35 public mi::base::Interface_declare<0x70c0a5e0,0x2ce2,0x4bd8,0xbe,0x4b,0xb0,0x34,0x32,0x83,0x11,0xd8,
36 nv::index::IObject_space_shape>
37{
38public:
44 virtual void set_point(const mi::math::Vector_struct<mi::Float32, 3>& point) = 0;
45
51 virtual mi::math::Vector_struct<mi::Float32, 3> get_point() const = 0;
52
57 virtual void set_normal(const mi::math::Vector_struct<mi::Float32, 3>& normal) = 0;
58
62 //
63 virtual mi::math::Vector_struct<mi::Float32, 3> get_normal() const = 0;
64
70 virtual void set_up(const mi::math::Vector_struct<mi::Float32, 3>& up) = 0;
71
77 virtual mi::math::Vector_struct<mi::Float32, 3> get_up() const = 0;
78
86 virtual void set_extent(const mi::math::Vector_struct<mi::Float32, 2>& extent) = 0;
87
92 virtual mi::math::Vector_struct<mi::Float32, 2> get_extent() const = 0;
93};
94
95}} // namespace index / nv
96
97#endif // NVIDIA_INDEX_IPLANE_H
Interface class representing a rectangular cutout of an infinite plane as part of the scene descripti...
Definition: iplane.h:37
virtual void set_extent(const mi::math::Vector_struct< mi::Float32, 2 > &extent)=0
Sets the extent of the plane's rectangular cutout.
virtual mi::math::Vector_struct< mi::Float32, 3 > get_up() const =0
Returns the up vector of the rectangular cutout, corresponding to the y-component of the plane extent...
virtual void set_up(const mi::math::Vector_struct< mi::Float32, 3 > &up)=0
Sets the up vector of the rectangular cutout, corresponding to the y-component of the plane extent.
virtual mi::math::Vector_struct< mi::Float32, 3 > get_normal() const =0
Returns the plane's normal vector.
virtual void set_point(const mi::math::Vector_struct< mi::Float32, 3 > &point)=0
Sets the point defining the position of the plane and also the origin of the rectangular cutout.
virtual void set_normal(const mi::math::Vector_struct< mi::Float32, 3 > &normal)=0
Sets the plane's normal vector.
virtual mi::math::Vector_struct< mi::Float32, 3 > get_point() const =0
Returns the point defining the position of the plane and also the origin of the rectangular cutout.
virtual mi::math::Vector_struct< mi::Float32, 2 > get_extent() const =0
Returns the extent of the plane's rectangular cutout.
Base class declaring the functionality of higher-level shapes.
Common namespace for all NVIDIA APIs.
Definition: iindex.h:349