iobject.h

Go to the documentation of this file.

/*
    toxic - A Global Illumination Renderer
    Copyright (C) 2003-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of toxic.

    toxic is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    toxic is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with toxic; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef TOXIC_RENDERER_IOBJECT_H
#define TOXIC_RENDERER_IOBJECT_H

#include "common/math/matrix4.h"
#include "basis.h"
#include "globals.h"

namespace toxic {

    class Context;
    class Framebuffer;
    class Hit;
    class ICamera;
    class ISurfaceShader;
    class Ray;
    class Scene;

    class IObject : public Basis {
    public:
        enum IntersectionMask {
            INTERSECT_NO_RAYS = 0,
            INTERSECT_VISIBILITY_RAYS = 1,
            INTERSECT_PRIMARY_RAYS = 2,
            INTERSECT_REFLECTED_RAYS = 4,
            INTERSECT_SHADOW_RAYS = 8,
            INTERSECT_PHOTON_RAYS = 16,
            INTERSECT_PRIMARY_FG_RAYS = 32,
            INTERSECT_SECONDARY_FG_RAYS = 64,
            INTERSECT_AUTOFOCUS_RAYS = 128,

            //! Handy shortcut.
            INTERSECT_ALL_RAYS =
                INTERSECT_VISIBILITY_RAYS |
                INTERSECT_PRIMARY_RAYS |
                INTERSECT_REFLECTED_RAYS |
                INTERSECT_SHADOW_RAYS |
                INTERSECT_PHOTON_RAYS |
                INTERSECT_PRIMARY_FG_RAYS |
                INTERSECT_SECONDARY_FG_RAYS |
                INTERSECT_AUTOFOCUS_RAYS
        };

#ifdef USE_MAILBOXES
        //!\todo Allocate one ray id per rendering thread.
        mutable int m_mailbox_ray_id;   //!< Id of the last ray tested against this object.
#endif  // USE_MAILBOXES

        //! m is the object space to world space transformation matrix.
        //! The 'surface_shader' pointer may be null because some objects
        //! (like the Collection and Octree objects) don't need a shader.
        IObject(
            const sheep::Matrix4 &m,
            const ISurfaceShader *surface_shader = 0,
            IntersectionMask intersection_mask = INTERSECT_ALL_RAYS
        );

        virtual ~IObject() {}

        //! This method must be called only once, after the object is completely
        //! configured, and before it is used for the first time.
        virtual void Finalize(const Context &context) {}

        //! This method returns the number of objects contained into this object.
        //! For primitives, it returns 1. For composite objects (like the Collection
        //! object), it returns the number of child objects.
        virtual int GetObjectCount() const { return 1; }

        void SetSurfaceShader(const ISurfaceShader *surface_shader);
        const ISurfaceShader *GetSurfaceShader() const;

        //! This method returns true if the ray intersect the object, or false otherwise.
        //! If 'hit' is not null, intersection data are reported through the 'hit' parameter
        //! (only if an intersection has been found; if no intersection has been found, the
        //! 'hit' parameter is left unchanged). The ray is expressed in world space.
        virtual bool Intersect(
            const Context &context,
            const Ray &ray,
            Hit *hit = 0
        ) const = 0;

        virtual void Annotate(
            const Context &context,
            const ICamera *camera,
            Framebuffer *framebuffer
        ) const {}

    protected:
        const ISurfaceShader *m_surface_shader;
        IntersectionMask m_intersection_mask;
    };

#include "iobject.inl"

}

#endif  // !TOXIC_RENDERER_IOBJECT_H

---