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 "Sort.h"

#include "DebugNew.h"

static const Vector3 dotScale(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),
    basePassFlags_(0),
    viewCamera_(0),
    worldBoundingBoxDirty_(true),
    lodLevelsDirty_(true)
{
}

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

void Drawable::RegisterObject(Context* context)
{
    ATTRIBUTE(Drawable, VAR_BOOL, "Is Visible", visible_, true);
    ATTRIBUTE(Drawable, VAR_BOOL, "Is Occluder", occluder_, false);
    ATTRIBUTE(Drawable, VAR_BOOL, "Cast Shadows", castShadows_, false);
    ATTRIBUTE(Drawable, VAR_FLOAT, "Draw Distance", drawDistance_, 0.0f);
    ATTRIBUTE(Drawable, VAR_FLOAT, "Shadow Distance", shadowDistance_, 0.0f);
    ATTRIBUTE(Drawable, VAR_FLOAT, "LOD Bias", lodBias_, 1.0f);
    ATTRIBUTE(Drawable, VAR_INT, "View Mask", viewMask_, DEFAULT_VIEWMASK);
    ATTRIBUTE(Drawable, VAR_INT, "Light Mask", lightMask_, DEFAULT_LIGHTMASK);
    ATTRIBUTE(Drawable, VAR_INT, "Max Lights", maxLights_, 0);
}

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().GetSize().DotProduct(dotScale);
    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::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::SetSortValue(float value)
{
    sortValue_ = value;
}

void Drawable::ClearBasePass()
{
    basePassFlags_ = 0;
    lights_.Clear();
}

void Drawable::SetBasePass(unsigned batchIndex)
{
    basePassFlags_ |= (1 << batchIndex);
}

void Drawable::AddLight(Light* light)
{
    lights_.Push(light);
}

void Drawable::LimitLights()
{
    Set<Light*> uniqueLights;
    
    const Vector3& worldPos = GetWorldPosition();
    for (unsigned i = 0; i < lights_.Size(); ++i)
        lights_[i]->SetIntensitySortValue(worldPos);
    
    Sort(lights_.Begin(), lights_.End(), CompareDrawables);
    
    for (unsigned i = 0; i < lights_.Size(); ++i)
    {
        // For split lights, take into account the original light instead, so that we do not get "partial" lighting
        Light* originalLight = lights_[i]->GetOriginalLight();
        if (originalLight)
            uniqueLights.Insert(originalLight);
        else
            uniqueLights.Insert(lights_[i]);
        
        // Stop when allowed light count exceeded
        if (uniqueLights.Size() > maxLights_)
        {
            lights_.Resize(i);
            return;
        }
    }
}

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

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

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;
        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);
    }
}