OpenSceneGraph/doc/doc++/osgUtil/CubeMapGenerator.html
2003-01-24 23:36:35 +00:00

126 lines
6.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class OSGUTIL_EXPORT osgUtil::CubeMapGenerator</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class OSGUTIL_EXPORT <A HREF="#DOC.DOCU">osgUtil::CubeMapGenerator</A></H2></H2><BLOCKQUOTE>This is the base class for cube map generators.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=155>
<param name=classes value="Mosg::Referenced,M,CCubeMapGenerator,MCubeMapGenerator.html,CReflectionMapGenerator,MReflectionMapGenerator.html,CHighlightMapGenerator,MHighlightMapGenerator.html,CHalfWayMapGenerator,MHalfWayMapGenerator.html">
<param name=before value="M,M,M|_,MR_,Mr_">
<param name=after value="Md_,M,M,M,M">
<param name=indent value="0,1,1,1,1">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>explicit <B><A HREF="#DOC.2.1.1">CubeMapGenerator</A></B>(int texture_size = 64)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.1.2">CubeMapGenerator</A></B>(const <!1><A HREF="CubeMapGenerator.html#DOC.2.1.2">CubeMapGenerator</A> &amp;copy, const osg::CopyOp &amp;copyop = osg::CopyOp::SHALLOW_COPY)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.3">generateMap</A></B>(bool use_osg_system = true)
<DD><I>generate the six cube images.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline osg::Image* <B><A HREF="#DOC.2.1.11">getImage</A></B>(osg::TextureCubeMap::Face face)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const osg::Image* <B><A HREF="#DOC.2.1.12">getImage</A></B>(osg::TextureCubeMap::Face face) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.1.13">set_pixel</A></B>(int index, int c, int r, const osg::Vec4 &amp;color)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline osg::Vec4 <B><A HREF="#DOC.2.1.14">vector_to_color</A></B>(const osg::Vec3 &amp;vec)
</DL></P>
<P><DL>
<DT><H3>Protected Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.1.4">~CubeMapGenerator</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="CubeMapGenerator.html">CubeMapGenerator</A>&amp; <B><A HREF="#DOC.2.1.5">operator=</A></B>(const <!1><A HREF="CubeMapGenerator.html">CubeMapGenerator</A> &amp;)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline static osg::Vec4 <B><A HREF="#DOC.2.1.6">vector_to_color</A></B>(const osg::Vec3 &amp;vec)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual osg::Vec4 <B><A HREF="#DOC.2.1.7">compute_color</A></B>(const osg::Vec3 &amp;R) const = 0
<DD><I>override this method to define how colors are computed.</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>This is the base class for cube map generators.
It exposes the necessary interface to access the six generated images;
descendants should only override the compute_color() method.</BLOCKQUOTE>
<DL>
<A NAME="CubeMapGenerator"></A>
<A NAME="DOC.2.1.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>explicit CubeMapGenerator(int texture_size = 64)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="CubeMapGenerator"></A>
<A NAME="DOC.2.1.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CubeMapGenerator(const <!1><A HREF="CubeMapGenerator.html#DOC.2.1.2">CubeMapGenerator</A> &amp;copy, const osg::CopyOp &amp;copyop = osg::CopyOp::SHALLOW_COPY)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="generateMap"></A>
<A NAME="DOC.2.1.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void generateMap(bool use_osg_system = true)</B></TT>
<DD>generate the six cube images.
If use_osg_system is true, then the OSG's coordinate system is used instead
of the default OpenGL one.
<DL><DT><DD></DL><P>
<A NAME="~CubeMapGenerator"></A>
<A NAME="DOC.2.1.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~CubeMapGenerator()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator="></A>
<A NAME="DOC.2.1.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="CubeMapGenerator.html">CubeMapGenerator</A>&amp; operator=(const <!1><A HREF="CubeMapGenerator.html">CubeMapGenerator</A> &amp;)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="vector_to_color"></A>
<A NAME="DOC.2.1.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline static osg::Vec4 vector_to_color(const osg::Vec3 &amp;vec)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="compute_color"></A>
<A NAME="DOC.2.1.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual osg::Vec4 compute_color(const osg::Vec3 &amp;R) const = 0</B></TT>
<DD>override this method to define how colors are computed.
The parameter R is the reflection vector, pointing from the center of the cube.
The return value should be the RGBA color associated with that reflection ray.
<DL><DT><DD></DL><P>
<A NAME="getImage"></A>
<A NAME="DOC.2.1.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline osg::Image* getImage(osg::TextureCubeMap::Face face)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getImage"></A>
<A NAME="DOC.2.1.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const osg::Image* getImage(osg::TextureCubeMap::Face face) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="set_pixel"></A>
<A NAME="DOC.2.1.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void set_pixel(int index, int c, int r, const osg::Vec4 &amp;color)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="vector_to_color"></A>
<A NAME="DOC.2.1.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline osg::Vec4 vector_to_color(const osg::Vec3 &amp;vec)</B></TT>
<DL><DT><DD></DL><P></DL>
<HR>
<DL><DT><B>Direct child classes:
</B><DD><A HREF="ReflectionMapGenerator.html">ReflectionMapGenerator</A><BR>
<A HREF="HighlightMapGenerator.html">HighlightMapGenerator</A><BR>
<A HREF="HalfWayMapGenerator.html">HalfWayMapGenerator</A><BR>
</DL>
<DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>