The set of higher-level 3D shapes part of the NVIDIA IndeX library includes a 3D cylinder.
More...
#include <icylinder.h>
Inherits mi::base::Interface_declare< 0x82b63cc6, ... >.
|
| virtual const mi::math::Vector_struct< mi::Float32, 3 > & | get_top () const =0 |
| | Get the top position of the 3D cylinder. More...
|
| |
| virtual void | set_top (const mi::math::Vector_struct< mi::Float32, 3 > &top)=0 |
| | Set the top position of the 3D cylinder. More...
|
| |
| virtual const mi::math::Vector_struct< mi::Float32, 3 > & | get_bottom () const =0 |
| | Get the bottom position of the 3D cylinder. More...
|
| |
| virtual void | set_bottom (const mi::math::Vector_struct< mi::Float32, 3 > &bottom)=0 |
| | Set the bottom position of the 3D cylinder. More...
|
| |
| virtual mi::Float32 | get_radius () const =0 |
| | Get the radius of the 3D cylinder. More...
|
| |
| virtual void | set_radius (mi::Float32 radius)=0 |
| | Set the radius of the 3D cylinder. More...
|
| |
| virtual bool | get_capped () const =0 |
| | A cylinder can be a solid, watertight 3D shape, i.e., its base is closed as if a cap covers the interior. More...
|
| |
| virtual void | set_capped (bool is_capped)=0 |
| | Setting the cap rendering. More...
|
| |
The set of higher-level 3D shapes part of the NVIDIA IndeX library includes a 3D cylinder.
ICylinder is a part of the scene description. A 3D cylinder is defined by its top and bottom position and a radius. Both positions need to be defined by a 3D coordinate in the cylinder's local coordinate system. A cylinder can be watertight, i.e., a closed object, if caps are enabled otherwise the top and the bottom of the cylinder is open. The surface of the cylinder is shaded using the material and light defined in the hierarchical scene description.
◆ get_bottom()
| virtual const mi::math::Vector_struct< mi::Float32, 3 > & nv::index::ICylinder::get_bottom |
( |
| ) |
const |
|
pure virtual |
Get the bottom position of the 3D cylinder.
- Returns
- The bottom position is defined in the local coordinate system of the cylinder.
◆ get_capped()
| virtual bool nv::index::ICylinder::get_capped |
( |
| ) |
const |
|
pure virtual |
A cylinder can be a solid, watertight 3D shape, i.e., its base is closed as if a cap covers the interior.
Instead of composing the capped shape manually, e.g., using a 3D disc, the shape interface class provides a flag that instructs the rendering system to render the cap automatically.
- Returns
- Returns if the cylinder shall be capped.
◆ get_radius()
| virtual mi::Float32 nv::index::ICylinder::get_radius |
( |
| ) |
const |
|
pure virtual |
Get the radius of the 3D cylinder.
- Returns
- The radius is defined in the local coordinate system of the 3D cylinder.
◆ get_top()
| virtual const mi::math::Vector_struct< mi::Float32, 3 > & nv::index::ICylinder::get_top |
( |
| ) |
const |
|
pure virtual |
Get the top position of the 3D cylinder.
- Returns
- The top position is defined in the local coordinate system of the cylinder.
◆ set_bottom()
| virtual void nv::index::ICylinder::set_bottom |
( |
const mi::math::Vector_struct< mi::Float32, 3 > & |
bottom | ) |
|
|
pure virtual |
Set the bottom position of the 3D cylinder.
- Parameters
-
| [in] | bottom | The bottom position is defined in the local coordinate system of the cylinder. |
◆ set_capped()
| virtual void nv::index::ICylinder::set_capped |
( |
bool |
is_capped | ) |
|
|
pure virtual |
Setting the cap rendering.
- Parameters
-
| [in] | is_capped | Enable or disable the cap rendering. |
◆ set_radius()
| virtual void nv::index::ICylinder::set_radius |
( |
mi::Float32 |
radius | ) |
|
|
pure virtual |
Set the radius of the 3D cylinder.
- Parameters
-
| [in] | radius | The radius is defined in the local coordinate system of the 3D cylinder. |
◆ set_top()
| virtual void nv::index::ICylinder::set_top |
( |
const mi::math::Vector_struct< mi::Float32, 3 > & |
top | ) |
|
|
pure virtual |
Set the top position of the 3D cylinder.
- Parameters
-
| [in] | top | The top position is defined in the local coordinate system of the cylinder. |
The documentation for this class was generated from the following file:
