A 3D cone is defined by its base's center and a tip.
More...
#include <icone.h>
Inherits mi::base::Interface_declare< 0xe2e95b32, ... >.
|
| virtual void | set_center (const mi::math::Vector_struct< mi::Float32, 3 > ¢er)=0 |
| | Sets center of the cone's base in its local coordinate system. More...
|
| |
| virtual const mi::math::Vector_struct< mi::Float32, 3 > & | get_center () const =0 |
| | Returns center of the cone's base in its local coordinate system. More...
|
| |
| virtual void | set_tip (const mi::math::Vector_struct< mi::Float32, 3 > &tip)=0 |
| | Sets the position of the tip in the cone's local coordinate system. More...
|
| |
| virtual const mi::math::Vector_struct< mi::Float32, 3 > & | get_tip () const =0 |
| | Returns the position of the tip in the cone's local coordinate system. More...
|
| |
| virtual void | set_radius (mi::Float32 radius)=0 |
| | Sets the cone's base radius. More...
|
| |
| virtual mi::Float32 | get_radius () const =0 |
| | Returns the cone's base radius. More...
|
| |
| virtual void | set_capped (bool is_capped)=0 |
| | Controls whether the cone is capped. More...
|
| |
| virtual bool | get_capped () const =0 |
| | Returns whether the cone is capped. More...
|
| |
A 3D cone is defined by its base's center and a tip.
Both need to be defined by a 3D coordinate in the cone's local coordinate system. A cone can be a closed object if caps are enabled, otherwise the base of the cone is open. The surface of the cone is shaded using the material and light defined in the scene description.
◆ get_capped()
| virtual bool nv::index::ICone::get_capped |
( |
| ) |
const |
|
pure virtual |
Returns whether the cone is capped.
- Returns
- True if the cone is capped.
◆ get_center()
| virtual const mi::math::Vector_struct< mi::Float32, 3 > & nv::index::ICone::get_center |
( |
| ) |
const |
|
pure virtual |
Returns center of the cone's base in its local coordinate system.
- Returns
- Center of the cone's base
◆ get_radius()
| virtual mi::Float32 nv::index::ICone::get_radius |
( |
| ) |
const |
|
pure virtual |
Returns the cone's base radius.
- Returns
- Base radius
◆ get_tip()
| virtual const mi::math::Vector_struct< mi::Float32, 3 > & nv::index::ICone::get_tip |
( |
| ) |
const |
|
pure virtual |
Returns the position of the tip in the cone's local coordinate system.
- Returns
- Tip of the cone.
◆ set_capped()
| virtual void nv::index::ICone::set_capped |
( |
bool |
is_capped | ) |
|
|
pure virtual |
Controls whether the cone is capped.
A cone can have closed base as if a cap covers the interior.
- Parameters
-
| [in] | is_capped | True when the cone should be capped. |
◆ set_center()
| virtual void nv::index::ICone::set_center |
( |
const mi::math::Vector_struct< mi::Float32, 3 > & |
center | ) |
|
|
pure virtual |
Sets center of the cone's base in its local coordinate system.
- Parameters
-
| [in] | center | Center of the cone's base |
◆ set_radius()
| virtual void nv::index::ICone::set_radius |
( |
mi::Float32 |
radius | ) |
|
|
pure virtual |
Sets the cone's base radius.
- Parameters
-
◆ set_tip()
| virtual void nv::index::ICone::set_tip |
( |
const mi::math::Vector_struct< mi::Float32, 3 > & |
tip | ) |
|
|
pure virtual |
Sets the position of the tip in the cone's local coordinate system.
- Parameters
-
| [in] | tip | Position of the tip of cone |
The documentation for this class was generated from the following file:
