%tutorialhelp%

Introduction

This tutorial will cover projecting decals on to a mesh. This is a common technique used to highlight units in certain strategy games by painting a circle on the ground around their feet. It could also be used to put a gun's laser sight on to its target.

The full source for this tutorial is here.

Note: There is also source available that uses the BaseApplication framework and Ogre 1.7 here.

projective_visual.png

Prerequisites

This tutorial assumes that you already know how to set up an Ogre project and compile it successfully. Knowledge of the topics from previous tutorials is also assumed.

The base code for this tutorial is here.

These two images are required for this tutorial:

 Plugin disabled
Plugin attach cannot be executed.
 Plugin disabled
Plugin attach cannot be executed.


Put these files into your media/materials/textures folder.

Note: The tutorial uses lower case names for these files (i.e. 'decal.png' and 'decal_filter.png'). Either save the images with lower case names or change the names when you add them to your code.

This tutorial also uses a material that is not from the Samples folder. You can use whatever material you want, but to get the look from the tutorial you can place this material into one of the material scripts. They are stored in '/media/materials/scripts'. Of course, you also have to make sure the 'spacesky.jpg' image is in your media folder as well.

material Tutorial/SpaceFloor
{
	technique
	{
		pass
		{
			texture_unit
			{
				texture spacesky.jpg
			}
		}
	}
}

Setting Up the Scene

First, comment out the setAmbientLight call at the beginning of createScene. Now, create a light and position the camera:

Ogre::Light* light = mSceneMgr->createLight("MainLight");
light->setPosition(0, 40, 0);

mCamera->setPosition(60, 100, 80);
mCamera->lookAt(0, 70, 0);

Now we'll add a floor plane.

Ogre::Plane plane;
plane.normal = Ogre::Vector3::UNIT_Y;
plane.d = 0;

Ogre::MeshManager::getSingleton().createPlane(
  "floor",
  Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME,
  plane,
  450.0, 450.0,
  10, 10, true, 1,
  50.0, 50.0,
  Ogre::Vector3::UNIT_Z);

Ogre::Entity* planeEntity = mSceneMgr->createEntity("floor");
planeEntity->setMaterialName("Tutorial/SpaceFloor");
planeEntity->setCastShadows(false);
mSceneMgr->getRootSceneNode()->createChildSceneNode()->attachObject(planeEntity);

This should all be familiar from the Basic Tutorial series. Next we are going to build a ring of Ogre heads to project our decals on to.

int numOfHeads = 14;
double radius = 180;
Ogre::Radian curAngle(0);
Ogre::Entity* ogreEntity;

for (int i = 0; i < numOfHeads; ++i)
{
  Ogre::SceneNode* headNode = mSceneMgr->getRootSceneNode()->createChildSceneNode();
  ogreEntity = mSceneMgr->createEntity("ogrehead.mesh");
  headNode->setScale(2.2, 2.8, 2.2);
  headNode->attachObject(ogreEntity);

  curAngle = curAngle + Ogre::Radian(Ogre::Math::TWO_PI / numOfHeads);

  headNode->setPosition(
    -radius * Ogre::Math::Sin(curAngle),
    20,
    -radius * Ogre::Math::Cos(curAngle));

  headNode->rotate(Ogre::Vector3::UNIT_Y, curAngle);
}

You can play around with the number of heads and the radius. Our code will automatically place them evenly around the circle. We won't go into the details here, but it's probably becomming clear that a good understanding of mathematics will be extremely useful for a graphics programmer. This is why you learned trigonometry in school. It was so you could build righteous Ogre head structures someday.

Projecting Decals

You create a frustum by chopping off the top of something like a pyramid or a cone. Here's a nice royalty free image of one:
frustum_visual.png
Ogre uses a frustum to represent the camera. In fact, the Camera class inherits directly from the Frustum class. This is why Ogre's representation of the camera doesn't behave as if it were a point-like object. When we called getCameraToViewportRay in previous tutorials it projected the rays from the "cap" of the Camera frustum. In this tutorial, we will be using a Frustum to project our decal onto the Ogre heads.

The first step will be creating the projector. Add the following to our BasicApp class:

BasicApp.h
void createProjector();
void addDecalToMaterial(const Ogre::String& matName);
BasicApp.cpp
void BasicApp::createProjector()
{
}

void BasicApp::addDecalToMaterial(const Ogre::String& matName);
{
}


Also add these to BasicApp class and initialize them to 0 in the constructor:

BasicApp.cpp
Ogre::SceneNode* mProjectorNode;
Ogre::Frustum* mDecalFrustum;
Ogre::Frustum* mFilterFrustum;


You might also need to use the foolowing inclusions:

BasicApp.cpp
#include <OgreMaterialManager.h>
#include <OgreTechnique.h>


We will get to the addDecalToMaterial method shortly. To start building our projector, we will first create the frustum. Add the following to createProjector:

mDecalFrustum = new Ogre::Frustum();

mProjectorNode = mSceneMgr->getRootSceneNode()->createChildSceneNode();
mProjectorNode->attachObject(mDecalFrustum);
mProjectorNode->setPosition(0, 30, 0);

The projector is placed in the center of the ring of Ogre heads. The image produced by this projector will grow larger as it moves farther away from the surface it is projecting onto. This is like how a real film projector would behave. If you wanted a projector which maintains a constant size image, then you would use code like this:

// Do not add to your project.
mDecalFrustum->setProjectionType(Ogre::PT_ORTHOGRAPHIC);
mDecalFrustum->setOrthoWindowHeight(100);

Applying the Decal

Even though we've already set up our projector, we still need to apply the projection to our entity's materials. We do this by creating a new Pass object which renders the decal on to our materials. In this tutorial, we will be modifying the material directly, but you should generally modify a copy of your materials so that you can return to the original material. Add the following to addDecalToMaterial:

Ogre::MaterialPtr mat =
  (Ogre::MaterialPtr)Ogre::MaterialManager::getSingleton().getByName(matName);
Ogre::Pass* pass = mat->getTechnique(0)->createPass();

Now that we have a Pass object, we need to set up blending and lighting. We will be adding a new texture which must be blended with the object's current texture. To do this, we will set the scene blending to be transparent alpha and the depth bias to one. This will make sure there is no transparency in the decal. Finally, we need to disable lighting for the material so that it will always show, like other GUI elements.

pass->setSceneBlending(Ogre::SBT_TRANSPARENT_ALPHA);
pass->setDepthBias(1);
pass->setLightingEnabled(false);

Now we'll create a new texture unit state using our decal.png file. We then turn on projective texturing and set some options.

Ogre::TextureUnitState* texState = pass->createTextureUnitState("decal.png");
texState->setProjectiveTexturing(true, mDecalFrustum);
texState->setTextureAddressingMode(Ogre::TextureUnitState::TAM_CLAMP);
texState->setTextureFiltering(Ogre::FO_POINT, Ogre::FO_LINEAR, Ogre::FO_NONE);

We have set the texture addressing mode to clamp so that the decal doesn't repeat on the object. We have set the magnification of the object to linear, and we have basically turned off minification (FO_POINT), and we've completely disabled mipmapping. This prevents the transparent edges of the decal from being blurred into our material.

That's the entire setup for the material.

Calling the Functions

We need to call the functions we've just built. Add the following to createScene right after the code to build the ogre heads:

createProjector();

for (unsigned int i = 0; i < planeEntity->getNumSubEntities(); ++i)
  addDecalToMaterial(planeEntity->getSubEntity(i)->getMaterialName());

for (unsigned int i = 0; i < ogreEntity->getNumSubEntities(); ++i)
  addDecalToMaterial(ogreEntity->getSubEntity(i)->getMaterialName());

The ent variable still has one of the Ogre head entities stored in it. Since all the heads use the same material, we can use any of them to grab the material name.

You might need to include:

#include <OgreSubEntity.h>

Compile and run the application, you should see the decal projected on to the heads.

Getting Rid of the Back Projection

As you've probably noticed, the decal is being projected forwards and backwards. Ogre projects the decal in both directions by default. For our current purposes, this is not what we want. To fix this, we will introduce a filter that will remove the back projection.

To filter the back projection, we need a new frustum for the filter which points in the direction we wish to filter. Add the following code to the createProjector method:

mFilterFrustum = new Ogre::Frustum();
mFilterFrustum->setProjectionType(Ogre::PT_ORTHOGRAPHIC);

Ogre::SceneNode* filterNode = mProjectorNode->createChildSceneNode();
filterNode->attachObject(mFilterFrustum);
filterNode->setOrientation(Ogre::Quaternion(Ogre::Degree(90),Ogre::Vector3::UNIT_Y));

This should all be familiar. The only difference is that we have rotated the node by 90 degrees.

Modifying the Material

We are going to add our filter as another texture unit state for the Pass we added to our material. Add the following to addDecalToMaterial:

texState = pass->createTextureUnitState("decal_filter.png");
texState->setProjectiveTexturing(true, mFilterFrustum);
texState->setTextureAddressingMode(Ogre::TextureUnitState::TAM_CLAMP);
texState->setTextureFiltering(Ogre::TFO_NONE);

We are using the 'decal_filter.png' texture and the filter frustum. We have also turned off filtering. This may seem strange, but it is just two different uses of the term filter. Compile and run the application. You should now only see the forward projection.

Rotating the Projection

Lastly, let's rotate the projector to help demonstrate the projection. Add the following to frameRenderingQueued:

mProjectorNode->rotate(Ogre::Vector3::UNIT_Y, Ogre::Degree(fe.timeSinceLastFrame * 10));

Compile and run the application. The projected decal should rotate around the circle of heads.

One Final Note

If you create decals for your own application, be sure they have a completely transparent border, otherwise they will be smeared because of the texture clamping process. The border only has to be one pixel wide.

Ogre can automatically pad your image with the necessary buffer if you set the texture address mode to TAM_BORDER (just {MONO()border{MONO} if set from a script). Also set the texture border colour to (0, 0, 0, 0). An implementation can be seen in Projective Decals.

Conclusion

In this tutorial, we projected a decal texture on to a series of meshes. This is a common technique used in a number of different applications, often to highlight objects in the scene. To do this, we used a frustum to represent the projection.

Ater constructing the projector, we still needed to apply the projection to the materials of our scene. Finally, we demonstrated that the projector can be moved, causing the projection to move through the scene. This is a relatively simple process that has an enormous number of applications.

More information is available in Projective Decals.

Exercises

Easy

  1. Experiment with the settings we've used to create and position the projector. You can create a lot of surprising effects by messing with them. For instance, if you just change the orientation we set for the filterNode to 180 degrees, you will project half of the decal forward and half of it backwards.

Intermediate

  1. Figure out how to generate the Ogre head meshes facing outwards from the circle instead of inward.

Difficult

  1. Right now we have the projector rotating. Change your application so that the projector moves up and down in a sinusoidal fashion while it rotates.

Advanced

  1. Attach the projector to our camera so that you can fly around the scene projecting the decal anywhere you look.

Full Source

The full source for this tutorial is here.

Next

Intermediate Tutorial 7


Alias: Intermediate_Tutorial_6

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.