NVIDIA IndeX API nvidia_logo_transpbg.gif Up

Plane. More...

#include <xac_interface_scene_elements_doc.h>

Public Types

typedef Sample_info_plane Base_info_type
 Declaration of the plane type. More...
 

Public Member Functions

bool is_valid () const
 Check if the properties of the current shape are valid. 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...
 
const float3 & get_position () const
 Get the plane origin position in scene space coordinates. More...
 
const float3 & get_normal () const
 Get the plane normal vector. More...
 
const float3 & get_right () const
 Get the plane right vector. More...
 
const float3 & get_up () const
 Get the plane upward pointing vector. More...
 
const float2 & get_extent () const
 Get the spatial extent of the plane in scene space coordinates. More...
 
uint get_light_id () const
 Retrieve associated scene light id. More...
 
uint get_material_id () const
 Retrieve associated scene material id. More...
 
xac::Colormap get_colormap () const
 Get the associated colormap. More...
 
xac::Colormap get_colormap_compute_texture () const
 Get the colormap associated to the compute texture. More...
 
bool has_compute_texture () const
 Check if the plane has an associated compute texture. More...
 
xac::Compute_texture_tile get_compute_texture () const
 Retrieve the compute texture associated to the plane. More...
 
bool has_compute_LOD_texture () const
 Check if the plane has an associated level of detail (LOD) compute texture. More...
 
xac::Compute_texture_LOD_tile get_compute_texture_LOD () const
 Retrieve the level of detail (LOD) compute texture associated to the plane. More...
 

Detailed Description

Member Typedef Documentation

 Base_info_type

Declaration of the plane type.

Member Function Documentation

 get_colormap()

xac::Colormap nv::index::xac::Plane::get_colormap ( ) const

Get the associated colormap.

 get_colormap_compute_texture()

xac::Colormap nv::index::xac::Plane::get_colormap_compute_texture ( ) const

Get the colormap associated to the compute texture.

 get_compute_texture()

xac::Compute_texture_tile nv::index::xac::Plane::get_compute_texture ( ) const

Retrieve the compute texture associated to the plane.

 get_compute_texture_LOD()

xac::Compute_texture_LOD_tile nv::index::xac::Plane::get_compute_texture_LOD ( ) const

Retrieve the level of detail (LOD) compute texture associated to the plane.

 get_distance()

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

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

 get_extent()

const float2 & nv::index::xac::Plane::get_extent ( ) const

Get the spatial extent of the plane in scene space coordinates.

 get_light_id()

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

Retrieve associated scene light id.

 get_material_id()

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

Retrieve associated scene material id.

 get_normal()

const float3 & nv::index::xac::Plane::get_normal ( ) const

Get the plane normal vector.

 get_position()

const float3 & nv::index::xac::Plane::get_position ( ) const

Get the plane origin position in scene space coordinates.

 get_right()

const float3 & nv::index::xac::Plane::get_right ( ) const

Get the plane right vector.

 get_up()

const float3 & nv::index::xac::Plane::get_up ( ) const

Get the plane upward pointing vector.

 has_compute_LOD_texture()

bool nv::index::xac::Plane::has_compute_LOD_texture ( ) const

Check if the plane has an associated level of detail (LOD) compute texture.

 has_compute_texture()

bool nv::index::xac::Plane::has_compute_texture ( ) const

Check if the plane has an associated compute texture.

 is_valid()

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

Check if the properties of the current shape are valid.


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