Ray::FileInstance Class Reference

#include <fileInstance.h>

Inheritance diagram for Ray::FileInstance:

Public Member Functions
	FileInstance (void)
std::string	name (void) const
void	init (const class LocalSceneData &data)
void	initOpenGL (void)
void	updateBoundingBox (void)
bool	processFirstIntersection (const Util::Ray3D &ray, const Util::BoundingBox1D &range, const RayIntersectionFilter &rFilter, const RayIntersectionKernel &rKernel, ShapeProcessingInfo spInfo, unsigned int tIdx) const
int	processAllIntersections (const Util::Ray3D &ray, const Util::BoundingBox1D &range, const RayIntersectionFilter &rFilter, const RayIntersectionKernel &rKernel, ShapeProcessingInfo spInfo, unsigned int tIdx) const
void	processOverlapping (const Filter &filter, const Kernel &kernel, ShapeProcessingInfo spInfo) const
bool	isInside (Util::Point3D p) const
void	drawOpenGL (GLSLProgram *glslProgram) const
Public Member Functions inherited from Ray::Shape
virtual	~Shape (void)
ShapeBoundingBox	boundingBox (void) const
virtual void	addTrianglesOpenGL (std::vector< class TriangleIndex > &triangles)
size_t	primitiveNum (void) const

Static Public Member Functions
static std::string	Directive (void)
Static Public Member Functions inherited from Ray::Shape
static void	WriteInset (std::ostream &stream)

Private Member Functions
void	_write (std::ostream &stream) const
void	_read (std::istream &stream)

Private Attributes
int	_fileIndex
const File *	_file

Additional Inherited Members
Public Types inherited from Ray::Shape
typedef std::function< ShapeProcessingInfo::ProcessingType(const ShapeProcessingInfo &, const Shape &) >	Filter
typedef std::function< void(const ShapeProcessingInfo &, const Shape &) >	Kernel
typedef std::function< bool(double) >	RayIntersectionFilter
typedef std::function< void(const ShapeProcessingInfo &, const class RayShapeIntersectionInfo &) >	RayIntersectionKernel
Static Public Attributes inherited from Ray::Shape
static unsigned int	OpenGLTessellationComplexity
static unsigned int	WriteInsetSize = 0
Protected Attributes inherited from Ray::Shape
ShapeBoundingBox	_bBox
size_t	_primitiveNum

Detailed Description

This subclass of RayShape stores a reference to a .ray file included in the scene-graph.

Constructor & Destructor Documentation

FileInstance()

FileInstance::FileInstance

(

void

)

The default constructor

Member Function Documentation

_read()

void FileInstance::_read ( std::istream &  stream )

privatevirtual

This method reads the Shape from the stream (excluding the starting directive)

Implements Ray::Shape.

_write()

void FileInstance::_write ( std::ostream &  stream ) const

privatevirtual

This method writes the Shape into the stream (including the starting directive)

Implements Ray::Shape.

Directive()

static std::string Ray::FileInstance::Directive ( void  )

inlinestatic

This static method returns the directive describing the shape.

drawOpenGL()

void FileInstance::drawOpenGL ( GLSLProgram *  glslProgram ) const

virtual

This method calls the necessary OpenGL commands to render the primitive.

Implements Ray::Shape.

init()

void FileInstance::init ( const class LocalSceneData &  data )

virtual

This method should be called (once) immediately after setting up the scene graph

Implements Ray::Shape.

initOpenGL()

void FileInstance::initOpenGL ( void  )

virtual

This method should be called (once) after an OpenGL context has been created

Implements Ray::Shape.

isInside()

bool FileInstance::isInside ( Util::Point3D  p ) const

virtual

This method determines if a point is inside a shape. It is assumed that if the shape is not water-tight, the method returns false.

Implements Ray::Shape.

name()

std::string Ray::FileInstance::name ( void  ) const

inlinevirtual

This method returns the name of the shape

Implements Ray::Shape.

processAllIntersections()

int FileInstance::processAllIntersections ( const Util::Ray3D &  ray, const Util::BoundingBox1D &  range, const RayIntersectionFilter &  rFilter, const RayIntersectionKernel &  rKernel, ShapeProcessingInfo  spInfo, unsigned int  tIdx  ) const

virtual

This method processes all shapes which intersect the ray within the prescribed range and passing the rFilter test, invoking the rKernel kernel with the intersection information. The processing terminates early if the kernel returns false. The function returns the number of valid intersections.

Implements Ray::Shape.

processFirstIntersection()

bool FileInstance::processFirstIntersection ( const Util::Ray3D &  ray, const Util::BoundingBox1D &  range, const RayIntersectionFilter &  rFilter, const RayIntersectionKernel &  rKernel, ShapeProcessingInfo  spInfo, unsigned int  tIdx  ) const

virtual

This method processes the first shape which intersect the ray within the prescribed range and passing the rFilter test, invoking the rKernel kernel with the intersection information. The function returns true if there was an intersection.

Implements Ray::Shape.

processOverlapping()

void FileInstance::processOverlapping ( const Filter &  filter, const Kernel &  kernel, ShapeProcessingInfo  spInfo  ) const

virtual

This method process Shapes by calling the "kernel" function on every shape whose bounding box passes the "filter" test. The tInfo parameter stores the accumulation of transformations encountered when traversing the scene-graph. Note that the bounding box is in the coordinate frame of the node.

Reimplemented from Ray::Shape.

updateBoundingBox()

void FileInstance::updateBoundingBox ( void  )

virtual

This method should be called to update the bounding boxes in the scene

Implements Ray::Shape.

Member Data Documentation

_file

const File* Ray::FileInstance::_file

private

The file associated to the instance

_fileIndex

int Ray::FileInstance::_fileIndex

private

The index of the file associated to the instance

---

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

• Assignments/Ray/fileInstance.h
• Assignments/Ray/fileInstance.cpp