urho3d/Engine/Graphics/Drawable.cpp

//  
// Urho3D Engine
// Copyright (c) 2008-2011 Lasse Öörni
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#include "Precompiled.h"
#include "Camera.h"
#include "Context.h"
#include "DebugRenderer.h"
#include "Light.h"
#include "Octree.h"
#include "OctreeQuery.h"
#include "Scene.h"
#include "Zone.h"

#include "Sort.h"

#include "DebugNew.h"

static const Vector3 DOT_SCALE(1 / 3.0f, 1 / 3.0f, 1 / 3.0f);

OBJECTTYPESTATIC(Drawable);

Drawable::Drawable(Context* context) :
    Component(context),
    octant_(0),
    drawDistance_(0.0f),
    shadowDistance_(0.0f),
    lodBias_(1.0f),
    viewMask_(DEFAULT_VIEWMASK),
    lightMask_(DEFAULT_LIGHTMASK),
    maxLights_(0),
    drawableFlags_(0),
    visible_(true),
    castShadows_(false),
    occluder_(false),
    distance_(0.0f),
    lodDistance_(0.0f),
    sortValue_(0.0f),
    viewFrameNumber_(0),
    viewCamera_(0),
    firstLight_(0),
    worldBoundingBoxDirty_(true),
    lodLevelsDirty_(true)
{
}

Drawable::~Drawable()
{
    RemoveFromOctree();
}

void Drawable::RegisterObject(Context* context)
{
    ATTRIBUTE(Drawable, VAR_INT, "Max Lights", maxLights_, 0, AM_DEFAULT);
    ATTRIBUTE(Drawable, VAR_INT, "View Mask", viewMask_, DEFAULT_VIEWMASK, AM_DEFAULT);
    ATTRIBUTE(Drawable, VAR_INT, "Light Mask", lightMask_, DEFAULT_LIGHTMASK, AM_DEFAULT);
}

void Drawable::ProcessRayQuery(RayOctreeQuery& query, float initialDistance)
{
    // By default just store the result from the bounding box raycast
    RayQueryResult result;
    result.drawable_ = this;
    result.node_ = GetNode();
    result.distance_ = initialDistance;
    query.result_.Push(result);
}

void Drawable::UpdateDistance(const FrameInfo& frame)
{
    distance_ = frame.camera_->GetDistance(GetWorldPosition());
    
    float scale = GetWorldBoundingBox().Size().DotProduct(DOT_SCALE);
    float newLodDistance = frame.camera_->GetLodDistance(distance_, scale, lodBias_);
    
    if (newLodDistance != lodDistance_)
    {
        lodDistance_ = newLodDistance;
        lodLevelsDirty_ = true;
    }
}

void Drawable::DrawDebugGeometry(DebugRenderer* debug, bool depthTest)
{
    debug->AddBoundingBox(GetWorldBoundingBox(), Color(0.0f, 1.0f, 0.0f), depthTest);
}

void Drawable::SetDrawDistance(float distance)
{
    drawDistance_ = distance;
}

void Drawable::SetShadowDistance(float distance)
{
    shadowDistance_ = distance;
}

void Drawable::SetLodBias(float bias)
{
    lodBias_ = Max(bias, M_EPSILON);
}

void Drawable::SetViewMask(unsigned mask)
{
    viewMask_ = mask;
}

void Drawable::SetLightMask(unsigned mask)
{
    lightMask_ = mask;
}

void Drawable::SetMaxLights(unsigned num)
{
    maxLights_ = num;
}

void Drawable::SetVisible(bool enable)
{
    visible_ = enable;
}

void Drawable::SetCastShadows(bool enable)
{
    castShadows_ = enable;
}

void Drawable::SetOccluder(bool enable)
{
    occluder_ = enable;
}

void Drawable::MarkForUpdate()
{
    if (octant_)
        octant_->GetRoot()->QueueUpdate(this);
}

const BoundingBox& Drawable::GetWorldBoundingBox()
{
    if (worldBoundingBoxDirty_)
    {
        OnWorldBoundingBoxUpdate();
        worldBoundingBoxDirty_ = false;
    }
    
    return worldBoundingBox_;
}

void Drawable::FindZone(PODVector<Drawable*>& result)
{
    // First check if the last zones are still valid, to avoid making a new octree query
    /// \todo Add zone mask to be able to exclude zones
    Vector3 center = GetWorldBoundingBox().Center();
    int bestPriority = M_MIN_INT;
    Zone* newZone = 0;
    for (Vector<WeakPtr<Zone> >::Iterator i = lastZones_.Begin(); i != lastZones_.End(); ++i)
    {
        Zone* zone = (*i);
        int priority = zone->GetPriority();
        if (zone && zone->IsInside(center) && priority > bestPriority)
        {
            newZone = zone;
            bestPriority = priority;
        }
    }
    
    if (!newZone)
    {
        Octree* octree = octant_->GetRoot();
        PointOctreeQuery query(result, center, DRAWABLE_ZONE);
        octree->GetDrawables(query);
        
        // Store the zone query result for next time
        lastZones_.Clear();
        PODVector<Zone*>& zoneResult = reinterpret_cast<PODVector<Zone*>&>(result);
        for (PODVector<Zone*>::Iterator i = zoneResult.Begin(); i != zoneResult.End(); ++i)
        {
            Zone* zone = (*i);
            int priority = zone->GetPriority();
            if (zone->IsInside(center) && priority > bestPriority)
            {
                newZone = zone;
                bestPriority = priority;
            }
            lastZones_.Push(WeakPtr<Zone>(*i));
        }
    }
    
    zone_ = newZone;
}

void Drawable::SetSortValue(float value)
{
    sortValue_ = value;
}

void Drawable::MarkInView(const FrameInfo& frame)
{
    viewFrameNumber_ = frame.frameNumber_;
    viewCamera_ = frame.camera_;
}

void Drawable::MarkInShadowView(const FrameInfo& frame)
{
    if (viewFrameNumber_ != frame.frameNumber_)
    {
        viewFrameNumber_ = frame.frameNumber_;
        viewCamera_ = 0;
    }
}

void Drawable::ClearLights()
{
    for (unsigned i = 0; i < basePassFlags_.Size(); ++i)
        basePassFlags_[i] = 0;
    firstLight_ = 0;
    lights_.Clear();
}

void Drawable::AddLight(Light* light)
{
    if (lights_.Empty())
        firstLight_ = light;
    lights_.Push(light);
}

void Drawable::LimitLights()
{
    // Maximum lights value 0 means unlimited
    if (!maxLights_)
        return;
    
    for (unsigned i = 0; i < lights_.Size(); ++i)
        lights_[i]->SetIntensitySortValue(GetWorldBoundingBox());
    
    Sort(lights_.Begin(), lights_.End(), CompareDrawables);
    
    // If more lights than allowed, cut the list
    if (lights_.Size() > maxLights_)
        lights_.Resize(maxLights_);
}

void Drawable::SetBasePass(unsigned batchIndex)
{
    unsigned index = batchIndex << 5;
    if (basePassFlags_.Size() <= index)
    {
        unsigned oldSize = basePassFlags_.Size();
        basePassFlags_.Resize(index + 1);
        for (unsigned i = oldSize; i <= index; ++i)
            basePassFlags_[i] = 0;
    }
    basePassFlags_[index] |= (1 << (batchIndex & 31));
}

Zone* Drawable::GetZone() const
{
    return zone_;
}

bool Drawable::IsInView(unsigned frameNumber) const
{
    return viewFrameNumber_ == frameNumber;
}

bool Drawable::IsInView(const FrameInfo& frame) const
{
    return viewFrameNumber_ == frame.frameNumber_ && viewCamera_ == frame.camera_;
}

bool Drawable::HasBasePass(unsigned batchIndex) const
{
    unsigned index = batchIndex >> 5;
    if (index < basePassFlags_.Size())
        return (basePassFlags_[index] & (1 << (batchIndex & 31))) != 0;
    else
        return false;
}

void Drawable::OnNodeSet(Node* node)
{
    // Insert initially into the root octant
    if (node)
    {
        AddToOctree();
        node->AddListener(this);
    }
    else
        RemoveFromOctree();
}

void Drawable::OnMarkedDirty(Node* node)
{
    if (node == node_)
    {
        worldBoundingBoxDirty_ = true;
        zone_.Reset();
        if (octant_)
            octant_->GetRoot()->QueueReinsertion(this);
    }
}

void Drawable::AddToOctree()
{
    Scene* scene = node_->GetScene();
    if (scene)
    {
        Octree* octree = scene->GetComponent<Octree>();
        if (octree)
            octree->AddDrawable(this);
    }
}

void Drawable::RemoveFromOctree()
{
    if (octant_)
    {
        Octree* octree = octant_->GetRoot();
        octree->CancelUpdate(this);
        octree->CancelReinsertion(this);
        octant_->RemoveDrawable(this);
    }
}