YafaRay Core  v3.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
object3d_t Class Referenceabstract

#include <object3d.h>

Inheritance diagram for object3d_t:
Inheritance graph
[legend]
Collaboration diagram for object3d_t:
Collaboration graph
[legend]

Public Member Functions

 object3d_t ()
 
virtual int numPrimitives () const =0
 
virtual int getPrimitives (const primitive_t **prims) const
 
virtual void setLight (const light_t *l)
 
virtual bool canSample ()
 
virtual bool enableSampling ()
 
virtual void sample (float s1, float s2, point3d_t &p, vector3d_t &n) const
 
void setVisibility (bool v)
 
void useAsBaseObject (bool v)
 
bool isVisible () const
 
bool isBaseObject () const
 
virtual ~object3d_t ()
 
void setObjectIndex (const float &newObjIndex)
 
void resetObjectIndex ()
 
void setObjectIndex (const int &newObjIndex)
 
float getAbsObjectIndex () const
 
float getNormObjectIndex () const
 
color_t getAbsObjectIndexColor () const
 
color_t getNormObjectIndexColor () const
 
color_t getAutoObjectIndexColor () const
 
color_t getAutoObjectIndexNumber () const
 

Protected Attributes

const light_tlight
 
bool visible
 toggle whether geometry is visible or only guidance for other stuff More...
 
bool is_base_mesh
 
float objectIndex
 Object Index for the object-index render pass. More...
 
color_t objectIndexAutoColor
 Object Index color automatically generated for the object-index-auto color render pass. More...
 
color_t objectIndexAutoNumber = 0.f
 Object Index number automatically generated for the object-index-auto-abs numeric render pass. More...
 

Static Protected Attributes

static unsigned int objectIndexAuto = 0
 Object Index automatically generated for the object-index-auto render pass. More...
 
static float highestObjectIndex = 1.f
 Class shared variable containing the highest object index used for the Normalized Object Index pass. More...
 

Detailed Description

Definition at line 20 of file object3d.h.

Constructor & Destructor Documentation

object3d_t::object3d_t ( )
inline

Definition at line 23 of file object3d.h.

virtual object3d_t::~object3d_t ( )
inlinevirtual

Definition at line 60 of file object3d.h.

Member Function Documentation

virtual bool object3d_t::canSample ( )
inlinevirtual

query whether object surface can be sampled right now

Definition at line 47 of file object3d.h.

virtual bool object3d_t::enableSampling ( )
inlinevirtual

try to enable sampling (may require additional memory and preprocessing time, if supported)

Definition at line 49 of file object3d.h.

float object3d_t::getAbsObjectIndex ( ) const
inline

Definition at line 68 of file object3d.h.

color_t object3d_t::getAbsObjectIndexColor ( ) const
inline

Definition at line 70 of file object3d.h.

color_t object3d_t::getAutoObjectIndexColor ( ) const
inline

Definition at line 79 of file object3d.h.

color_t object3d_t::getAutoObjectIndexNumber ( ) const
inline

Definition at line 83 of file object3d.h.

float object3d_t::getNormObjectIndex ( ) const
inline

Definition at line 69 of file object3d.h.

color_t object3d_t::getNormObjectIndexColor ( ) const
inline

Definition at line 74 of file object3d.h.

virtual int object3d_t::getPrimitives ( const primitive_t **  prims) const
inlinevirtual

write the primitive pointers to the given array

Returns
number of written primitives

Reimplemented in primObject_t, and meshObject_t.

Definition at line 43 of file object3d.h.

bool object3d_t::isBaseObject ( ) const
inline

Returns if this object is used as base object for instances.

Definition at line 59 of file object3d.h.

bool object3d_t::isVisible ( ) const
inline

Returns if this object should be used for rendering.

Definition at line 57 of file object3d.h.

virtual int object3d_t::numPrimitives ( ) const
pure virtual

the number of primitives the object holds. Primitive is an element that by definition can perform ray-triangle intersection

Implemented in triangleObjectInstance_t, primObject_t, triangleObject_t, and meshObject_t.

void object3d_t::resetObjectIndex ( )
inline

Definition at line 66 of file object3d.h.

virtual void object3d_t::sample ( float  s1,
float  s2,
point3d_t p,
vector3d_t n 
) const
inlinevirtual

sample object surface

Definition at line 51 of file object3d.h.

virtual void object3d_t::setLight ( const light_t l)
inlinevirtual

set a light source to be associated with this object

Reimplemented in meshObject_t.

Definition at line 45 of file object3d.h.

void object3d_t::setObjectIndex ( const float &  newObjIndex)
inline

Definition at line 61 of file object3d.h.

void object3d_t::setObjectIndex ( const int &  newObjIndex)
inline

Definition at line 67 of file object3d.h.

void object3d_t::setVisibility ( bool  v)
inline

Sets the object visibility to the renderer (is added or not to the kdtree)

Definition at line 53 of file object3d.h.

void object3d_t::useAsBaseObject ( bool  v)
inline

Indicates that this object should be used as base object for instances

Definition at line 55 of file object3d.h.

Member Data Documentation

__BEGIN_YAFRAY float object3d_t::highestObjectIndex = 1.f
staticprotected

Class shared variable containing the highest object index used for the Normalized Object Index pass.

Definition at line 96 of file object3d.h.

bool object3d_t::is_base_mesh
protected

Definition at line 91 of file object3d.h.

const light_t* object3d_t::light
protected

Definition at line 89 of file object3d.h.

float object3d_t::objectIndex
protected

Object Index for the object-index render pass.

Definition at line 92 of file object3d.h.

unsigned int object3d_t::objectIndexAuto = 0
staticprotected

Object Index automatically generated for the object-index-auto render pass.

Definition at line 93 of file object3d.h.

color_t object3d_t::objectIndexAutoColor
protected

Object Index color automatically generated for the object-index-auto color render pass.

Definition at line 94 of file object3d.h.

color_t object3d_t::objectIndexAutoNumber = 0.f
protected

Object Index number automatically generated for the object-index-auto-abs numeric render pass.

Definition at line 95 of file object3d.h.

bool object3d_t::visible
protected

toggle whether geometry is visible or only guidance for other stuff

Definition at line 90 of file object3d.h.


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