IFD_IPRObject Class Reference

#include <IFD_IPRObject.h>

Inheritance diagram for IFD_IPRObject:

UT_SmallObject< IFD_IPRObject, UT_SMALLOBJECT_CLEANPAGES_ON, 1024, UT_SMALLOBJECT_THREADSAFE_ON > UT_SmallObjectDefaultSuperClass

List of all members.

Public Member Functions

 IFD_IPRObject (IFD_IPRTree *tree)
virtual ~IFD_IPRObject ()
virtual ROP_IPRObject * castToROP ()
virtual const ROP_IPRObject * castToROP () const
bool isInScene () const
void setInScene (bool onoff)
void setTreeIndex (int idx)
int getTreeIndex () const
virtual bool isDirty (const char *attribute)=0
virtual int getUniqueId () const =0
virtual int getGeometryObject (int) const
virtual int getInstancePoint (int) const
virtual int getSurfaceId (int, int) const
virtual int getDisplaceId (int, int) const
virtual void dump ()
 Debug dump of object information.
virtual int save (ostream &os)
virtual bool load (UT_IStream &is, float now)
virtual int afterLoad (float now)

Protected Member Functions

void setTreeDirty ()

Protected Attributes

IFD_IPRTreemyTree
int myTreeIndex
bool myInScene


Detailed Description

Definition at line 36 of file IFD_IPRObject.h.


Constructor & Destructor Documentation

IFD_IPRObject::IFD_IPRObject ( IFD_IPRTree tree  ) 

virtual IFD_IPRObject::~IFD_IPRObject (  )  [virtual]


Member Function Documentation

virtual int IFD_IPRObject::afterLoad ( float  now  )  [inline, virtual]

Definition at line 87 of file IFD_IPRObject.h.

virtual const ROP_IPRObject* IFD_IPRObject::castToROP (  )  const [virtual]

virtual ROP_IPRObject* IFD_IPRObject::castToROP (  )  [virtual]

virtual void IFD_IPRObject::dump (  )  [virtual]

Debug dump of object information.

virtual int IFD_IPRObject::getDisplaceId ( int  ,
int   
) const [inline, virtual]

Definition at line 80 of file IFD_IPRObject.h.

virtual int IFD_IPRObject::getGeometryObject ( int   )  const [inline, virtual]

Definition at line 77 of file IFD_IPRObject.h.

virtual int IFD_IPRObject::getInstancePoint ( int   )  const [inline, virtual]

Definition at line 78 of file IFD_IPRObject.h.

virtual int IFD_IPRObject::getSurfaceId ( int  ,
int   
) const [inline, virtual]

Definition at line 79 of file IFD_IPRObject.h.

int IFD_IPRObject::getTreeIndex (  )  const [inline]

Definition at line 60 of file IFD_IPRObject.h.

virtual int IFD_IPRObject::getUniqueId (  )  const [pure virtual]

The unique ID needs to be unique since it's used to index into a hash table. Ideally, this should just be the OPs unique id.

virtual bool IFD_IPRObject::isDirty ( const char *  attribute  )  [pure virtual]

Determines whether an attribute of the object is dirty or not. For example, one might call light->isDirty("shader"). Attributes are currently: space - Transform space texture - Texture/Shader space surface - Instance/Detail surface shader displace - Instance/Detail displacement shader lmask - Instance light mask shader - Light shader shadow - Light shadow shader

bool IFD_IPRObject::isInScene (  )  const [inline]

When re-rendering an scene using IPR, it's possible that some objects may not be included in the render. There are several possible causes for this: A Houdini object has been deleted The visible object/light/fog mask has changed The display flag has been turned off etc.

Definition at line 56 of file IFD_IPRObject.h.

virtual bool IFD_IPRObject::load ( UT_IStream is,
float  now 
) [inline, virtual]

Definition at line 86 of file IFD_IPRObject.h.

virtual int IFD_IPRObject::save ( ostream &  os  )  [inline, virtual]

Definition at line 85 of file IFD_IPRObject.h.

void IFD_IPRObject::setInScene ( bool  onoff  )  [inline]

Definition at line 57 of file IFD_IPRObject.h.

void IFD_IPRObject::setTreeDirty (  )  [protected]

Flag the whole tree as dirty (this should be done any time a node becomes dirty). The tree may become flagged as "clean" again (after a re-render), this is regardless of the dirty state of each node.

void IFD_IPRObject::setTreeIndex ( int  idx  )  [inline]

Definition at line 59 of file IFD_IPRObject.h.


Member Data Documentation

bool IFD_IPRObject::myInScene [protected]

Definition at line 98 of file IFD_IPRObject.h.

Definition at line 96 of file IFD_IPRObject.h.

int IFD_IPRObject::myTreeIndex [protected]

Definition at line 97 of file IFD_IPRObject.h.


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

Generated on Fri May 25 00:10:30 2012 for HDK by  doxygen 1.5.9