Package com.victorvalentim.zividomelive

Class SceneEnvironmentService

java.lang.Object
com.victorvalentim.zividomelive.SceneEnvironmentService
public final class SceneEnvironmentService extends Object
Activation-scoped environment configuration that restores the facade state it replaced.

Restoration is ownership-safe: a property is restored only if it still contains the value applied by this activation, so a later owner is not overwritten.

API stability: Advanced Stable.

Since:
2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Temporarily clears the current source for this activation.
    float
    getIntensity()
     
    float
    getYawOffset()
     
    boolean
    isVisible()
     
    void
    resetOrientation()
    Resets the source-image alignment to identity for this activation.
    void
    setEquirectangular(processing.core.PImage image)
    Sets the borrowed equirectangular source for this activation.
    void
    setIntensity(float intensity)
    Sets the non-negative visual colour multiplier for this activation.
    void
    setOrientationAxisAngle(float axisX, float axisY, float axisZ, float angle)
    Sets a fixed axis-angle rotation applied directly to the equirectangular source lookup.
    void
    setVisible(boolean visible)
    Sets Environment visibility for this activation.
    void
    setYawOffset(float yawOffset)
    Sets the source-longitude offset for this activation.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • setEquirectangular

      public void setEquirectangular(processing.core.PImage image)
      Sets the borrowed equirectangular source for this activation.
      Parameters:
      image - borrowed equirectangular source, or null to clear temporarily

    • clear

      public void clear()
      Temporarily clears the current source for this activation.

    • setVisible

      public void setVisible(boolean visible)
      Sets Environment visibility for this activation.
      Parameters:
      visible - true to render the Environment

    • setIntensity

      public void setIntensity(float intensity)
      Sets the non-negative visual colour multiplier for this activation.
      Parameters:
      intensity - visual multiplier; finite negative values are clamped to zero and non-finite values are ignored

    • setYawOffset

      public void setYawOffset(float yawOffset)
      Sets the source-longitude offset for this activation.
      Parameters:
      yawOffset - offset in radians; non-finite values are ignored

    • isVisible

      public boolean isVisible()
      Returns:
      current Environment visibility

    • getIntensity

      public float getIntensity()
      Returns:
      current non-negative visual colour multiplier

    • getYawOffset

      public float getYawOffset()
      Returns:
      current source-longitude offset in radians

    • setOrientationAxisAngle

      public void setOrientationAxisAngle(float axisX, float axisY, float axisZ, float angle)
      Sets a fixed axis-angle rotation applied directly to the equirectangular source lookup. This aligns the background image without changing dome pitch/yaw/roll or scene geometry.
      Parameters:
      axisX - rotation-axis X component
      axisY - rotation-axis Y component
      axisZ - rotation-axis Z component
      angle - rotation angle in radians
      Throws:
      IllegalArgumentException - when a component is non-finite or a non-zero rotation has a zero-length axis

    • resetOrientation

      public void resetOrientation()
      Resets the source-image alignment to identity for this activation.