VRS - The Virtual Rendering System

version 3.3

rayrequest.h

Go to the documentation of this file.

 /**********************************************************************
 VRS - The Virtual Rendering System
 Copyright (C) 2001 Computer Graphics Systems Group at the 
 Hasso-Plattner-Institute, Potsdam, Germany.
 This library is free software; you can redistribute it and/or 
 modify it under the terms of the GNU Lesser General Public 
 License as published by the Free Software Foundation; either 
 version 2.1 of the License, or (at your option) any later version.
 This library 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 Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser+ General Public
 License along with this library; if not, write to the FreeSoftware 
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA, 02111-1307, USA.
 **********************************************************************/
// $Id: rayrequest.h 5265 2006-03-31 09:42:42Z baumann $
// $Date: 2006-03-31 11:42:42 +0200 (Fri, 31 Mar 2006) $
// $Revision: 5265 $
// $State$
// $Author: baumann $
//
// $Log$
// Revision 1.17  2006/03/31 09:42:42  baumann
// added static methods pushHint(), popHint(), hasHint(), and getHint() to VRS::RayRequest
//
// Revision 1.16  2005/01/03 01:43:08  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.15  2004/10/27 14:30:10  kirsch
// use isSimple property of ShapeSimplifiers to invoke shaders and techniques
// only once during the shape evaluation process
//
// Revision 1.14  2004/09/17 12:56:29  baumann
// comment fixed
//
// Revision 1.13  2004/05/11 06:55:17  baumann
// - methods set/getShapeFilter() moved to base class TechniqueProcessor
// - impl of method TechniqueProcessor::getTechniqueFilter() added
// - method disableRayIntersectionTag() added
//
// Revision 1.12  2004/03/12 16:28:39  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.11  2003/11/07 14:19:24  kirsch
// removed leading underscore from include guards
//
// Revision 1.10  2002/10/29 10:32:52  baumann
// macros VRS_CLASSNAME_* and VRS_IMPL_TYPEINFO_* removed
//
// Revision 1.9  2002/03/03 21:44:25  kosta
// VRS_TYPEINFO-macro rewritten
//
// Revision 1.8  2002/02/19 10:34:11  kosta
// undone all changes since 2002-02-15
//
// Revision 1.5  2002/01/15 16:25:54  kosta
// macros rewritten for a better namespace support
//
// Revision 1.4  2001/11/13 16:36:30  kirsch
// changed line feed to unix style (removed control-M)
//
// Revision 1.3  2001/08/24 12:55:58  kirsch
// RayRequest totally rewritten, uses RayTracingTechnique and RayRequestTechnique
//
// Revision 1.2  2001/07/05 12:43:14  kersting
// added enum name and set method parameters due to enum name
//
// Revision 1.1.1.1  2001/06/08 08:09:20  kirsch
// imported alpha-version by olli 
//


#ifndef VRS_RAYREQUEST_H
#define VRS_RAYREQUEST_H

#include <vrs/ray.h>
#include <vrs/rayrequesttechnique.h>
#include <vrs/techniqueprocessor.h>

namespace VRS {

class FilterTag;

class VRS_CORE_API RayRequest :
    public TechniqueProcessor
{
public:
        VRS_TYPEINFO(RayRequest, TechniqueProcessor);

    RayRequest(
        RayRequestTechnique::RQMode mode = RayRequestTechnique::All, 
        Filter* filter = NULL,
        const Ray& = Ray(),
        RayRequestTechnique::RQType rayType = RayRequestTechnique::Clip
    );

    void setRay(
        const Ray& ray,
        RayRequestTechnique::RQType rayType = RayRequestTechnique::Clip
    );
    Ray getRay() const;
    void setMode(RayRequestTechnique::RQMode m);
    RayRequestTechnique::RQMode getMode() const;
    int results() const;
    IntersectionInfo* result(int i = 0) const;
    void clear();
    static SO<FilterTag> disableRayIntersectionTag();
        /*<! Returns a filter tag that can be used to specify
             that certain shapes should not be evaluated during
             the ray tracing process. */

    virtual const Handler* getNativeHandler(Engine*, const ID&) const;
    virtual bool handleNatively(Engine*, const Shape*, const Handler*);
    static void pushHint(int hint);
    static void popHint();
    static bool hasHint();
    static int getHint();

protected:
        virtual void pushStandardTechniques(Engine*);
        virtual void popStandardTechniques(Engine*);

protected:
    virtual SO<Filter> getTechniqueFilter() const;
    //<! See TechniqueProcessor.

private:
    SO<RayRequestTechnique> m_rayrequestTechnique;
};

inline void RayRequest::setRay(const Ray& ray, RayRequestTechnique::RQType rayType) {
    m_rayrequestTechnique->setRay(ray, rayType);
}

inline Ray RayRequest::getRay() const {
    return m_rayrequestTechnique->getRay();
}

inline void RayRequest::setMode(RayRequestTechnique::RQMode m) { 
    m_rayrequestTechnique->setMode(m);
}

inline RayRequestTechnique::RQMode RayRequest::getMode() const { 
    return (m_rayrequestTechnique->getMode());
}

inline int RayRequest::results() const {
    return (m_rayrequestTechnique->results());
}

inline IntersectionInfo* RayRequest::result(int i) const {
    return (m_rayrequestTechnique->result(i));
}

inline void RayRequest::clear() {
    m_rayrequestTechnique->clear();
}

} // namespace VRS

#endif // VRS_RAYREQUEST_H

---

Generated on Wed May 23 06:00:13 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact