Interface class representing a rectangular cutout of an infinite plane as part of the scene description.
More...
#include <iplane.h>
Inherits mi::base::Interface_declare< 0x70c0a5e0, ... >.
|
| 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. More...
|
| |
| 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. More...
|
| |
| virtual void | set_normal (const mi::math::Vector_struct< mi::Float32, 3 > &normal)=0 |
| | Sets the plane's normal vector. More...
|
| |
| virtual mi::math::Vector_struct< mi::Float32, 3 > | get_normal () const =0 |
| | Returns the plane's normal vector. More...
|
| |
| 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. More...
|
| |
| 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. More...
|
| |
| virtual void | set_extent (const mi::math::Vector_struct< mi::Float32, 2 > &extent)=0 |
| | Sets the extent of the plane's rectangular cutout. More...
|
| |
| virtual mi::math::Vector_struct< mi::Float32, 2 > | get_extent () const =0 |
| | Returns the extent of the plane's rectangular cutout. More...
|
| |
Interface class representing a rectangular cutout of an infinite plane as part of the scene description.
A plane is a geometric structure defined by a position, a orientation, and a rectangular cutout. The position and orientation of the plane are defined by a point and a normal vector. The rectangular cutout stretches from the given point into the directions of the up vector and the right vector (which is perpendicular to normal and up). The x-component of the extent specifies the size in the direction of the right vector and the y-component corresponds to the up vector.
The texture implemented by a IDistributed_compute_technique attribute may be assigned to the plane.
◆ get_extent()
| virtual mi::math::Vector_struct< mi::Float32, 2 > nv::index::IPlane::get_extent |
( |
| ) |
const |
|
pure virtual |
Returns the extent of the plane's rectangular cutout.
- Returns
- The 2D extent.
◆ get_normal()
| virtual mi::math::Vector_struct< mi::Float32, 3 > nv::index::IPlane::get_normal |
( |
| ) |
const |
|
pure virtual |
Returns the plane's normal vector.
- Returns
- The plane's normal vector.
◆ get_point()
| virtual mi::math::Vector_struct< mi::Float32, 3 > nv::index::IPlane::get_point |
( |
| ) |
const |
|
pure virtual |
Returns the point defining the position of the plane and also the origin of the rectangular cutout.
- Returns
- The point that defines the lower left corner of the rectangular cutout.
◆ get_up()
| virtual mi::math::Vector_struct< mi::Float32, 3 > nv::index::IPlane::get_up |
( |
| ) |
const |
|
pure virtual |
Returns the up vector of the rectangular cutout, corresponding to the y-component of the plane extent.
- Returns
- The up vector.
◆ set_extent()
| virtual void nv::index::IPlane::set_extent |
( |
const mi::math::Vector_struct< mi::Float32, 2 > & |
extent | ) |
|
|
pure virtual |
Sets the extent of the plane's rectangular cutout.
- Note
- Currently, a plane cannot be infinite.
- Parameters
-
| [in] | extent | The 2D extent, with the x-component giving the size in the direction of the right vector and the y-component corresponding to the up vector. |
◆ set_normal()
| virtual void nv::index::IPlane::set_normal |
( |
const mi::math::Vector_struct< mi::Float32, 3 > & |
normal | ) |
|
|
pure virtual |
Sets the plane's normal vector.
- Parameters
-
| [in] | normal | The plane's normal vector. |
◆ set_point()
| virtual void nv::index::IPlane::set_point |
( |
const mi::math::Vector_struct< mi::Float32, 3 > & |
point | ) |
|
|
pure virtual |
Sets the point defining the position of the plane and also the origin of the rectangular cutout.
- Parameters
-
| [in] | point | Defines the lower left corner of the rectangular cutout. |
◆ set_up()
| virtual void nv::index::IPlane::set_up |
( |
const mi::math::Vector_struct< mi::Float32, 3 > & |
up | ) |
|
|
pure virtual |
Sets the up vector of the rectangular cutout, corresponding to the y-component of the plane extent.
- Parameters
-
The documentation for this class was generated from the following file:
