simplex3d.engine.graphics.EnvironmentalEffect.scala Maven / Gradle / Ivy

Go to download
/*
 * Simplex3dEngine - Core Module
 * Copyright (C) 2011, Aleksey Nikiforov
 *
 * This file is part of Simplex3dEngine.
 *
 * Simplex3dEngine 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 3 of the License, or
 * (at your option) any later version.
 *
 * Simplex3dEngine 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 program.  If not, see .
 */

package simplex3d.engine
package graphics

import simplex3d.math.types._
import simplex3d.engine.util._


trait ReadEnvironmentalEffect extends Protected with PropertyContextDependent {
  type Read <: ReadEnvironmentalEffect
  type Mutable <: EnvironmentalEffect
  
  def propagate(parentVal: Read, result: Mutable) :Unit //XXX hide this as well
  
  
  //*** PropertyContext Code ******************************************************************************************
  
  private var context: PropertyContext = _
  
  private[engine] override def register(context: PropertyContext) {
    this.context = context
  }
  
  private[engine] override def unregister() {
    context = null
  }
  
  protected def registerPropertyContext(context: PropertyContext) {}
  protected def unregisterPropertyContext() {}
  
  
  //*** Environmental Effect Code *************************************************************************************
  
  protected var unsafeBinding: Binding = null
  protected def resolveBinding() :Binding
  
  /** Must return a stable binding that will no change until the next binding change event.
   */
  final def binding: Binding = {
    if (unsafeBinding == null) unsafeBinding = resolveBinding()
    unsafeBinding
  }
  
  protected final def signalStructuralChanges() {
    unsafeBinding = null
    context.signalStructuralChanges()
  }
}

trait EnvironmentalEffect extends ReadEnvironmentalEffect with Accessible {
  protected def mkMutable() :Mutable
  
  override def mutableCopy: Mutable = {
    val copy = mkMutable()
    copy := this.asInstanceOf[copy.Read]
    copy
  }
}


//XXX split into pass-level and mesh-level updatables, also better names
trait ReadUpdatableEnvironmentalEffect extends ReadEnvironmentalEffect with Protected {
  type Read <: ReadUpdatableEnvironmentalEffect
  type Mutable <: UpdatableEnvironmentalEffect
  
  /** Update the stable binding with a set of predefined uniforms that are only available at the time of rendering.
   * 
   * Values that depend on camera must be taken from predefined uniforms,
   * so that passes with different cameras can be rendered correctly. 
   */
  def updateBinding(predefinedUniforms: ReadPredefinedUniforms) :Unit //XXX hide this from the client code
}

trait UpdatableEnvironmentalEffect extends ReadUpdatableEnvironmentalEffect with EnvironmentalEffect {
}