NVIDIA IndeX API nvidia_logo_transpbg.gif Up

Cylinder. More...

#include <xac_interface_scene_elements_doc.h>

Public Types

typedef Sample_info_surface Base_info_type
 Declaration of the surface type info. More...
 

Public Member Functions

uint get_light_id () const
 Retrieve associated scene light id. More...
 
uint get_material_id () const
 Retrieve associated material light id. More...
 
const float3 & get_bottom () const
 Get the bottom position of the cylinder in scene space coordinates. More...
 
const float3 & get_top () const
 Get the top position of the cylinder in scene space coordinates. More...
 
float get_radius () const
 Get the scene space radius of the cylinder. More...
 
bool is_valid () const
 Check if the properties of the current shape are valid. More...
 
bool is_capped () const
 Check if the cap surfaces of the cylinder are active. More...
 
bool is_inside (const float3 &world_position) const
 Check if a given position in scene space coordinates is inside the boundary surface. More...
 
float get_distance (const float3 &scene_position) const
 Compute the signed distance to the boundary surface for a given position in scene space coordinates. More...
 

Detailed Description

Member Typedef Documentation

 Base_info_type

Declaration of the surface type info.

Member Function Documentation

 get_bottom()

const float3 & nv::index::xac::Cylinder::get_bottom ( ) const

Get the bottom position of the cylinder in scene space coordinates.

 get_distance()

float nv::index::xac::Cylinder::get_distance ( const float3 &  scene_position) const

Compute the signed distance to the boundary surface for a given position in scene space coordinates.

 get_light_id()

uint nv::index::xac::Cylinder::get_light_id ( ) const

Retrieve associated scene light id.

 get_material_id()

uint nv::index::xac::Cylinder::get_material_id ( ) const

Retrieve associated material light id.

 get_radius()

float nv::index::xac::Cylinder::get_radius ( ) const

Get the scene space radius of the cylinder.

 get_top()

const float3 & nv::index::xac::Cylinder::get_top ( ) const

Get the top position of the cylinder in scene space coordinates.

 is_capped()

bool nv::index::xac::Cylinder::is_capped ( ) const

Check if the cap surfaces of the cylinder are active.

 is_inside()

bool nv::index::xac::Cylinder::is_inside ( const float3 &  world_position) const

Check if a given position in scene space coordinates is inside the boundary surface.

 is_valid()

bool nv::index::xac::Cylinder::is_valid ( ) const

Check if the properties of the current shape are valid.


The documentation for this class was generated from the following file: