Class SCNLight

All Implemented Interfaces:
NSCoding, NSObjectProtocol, NSSecureCoding, SCNAnimatable, SCNTechniqueSupport, ObjCProtocol

public class SCNLight
extends NSObject
implements SCNAnimatable, NSSecureCoding, SCNTechniqueSupport
  • Constructor Details

    • SCNLight

      public SCNLight()
    • SCNLight

      protected SCNLight​(NSObject.Handle h, long handle)
    • SCNLight

      protected SCNLight​(NSObject.SkipInit skipInit)
    • SCNLight

      public SCNLight​(NSCoder coder)
  • Method Details

    • getType

      public SCNLightType getType()
    • setType

      public void setType​(SCNLightType v)
    • getColor

      public UIColor getColor()
    • setColor

      public void setColor​(UIColor v)
    • getTemperature

      public double getTemperature()
      Since:
      Available in iOS 10.0 and later.
    • setTemperature

      public void setTemperature​(double v)
      Since:
      Available in iOS 10.0 and later.
    • getIntensity

      public double getIntensity()
      Since:
      Available in iOS 10.0 and later.
    • setIntensity

      public void setIntensity​(double v)
      Since:
      Available in iOS 10.0 and later.
    • getName

      public String getName()
    • setName

      public void setName​(String v)
    • castsShadow

      public boolean castsShadow()
    • setCastsShadow

      public void setCastsShadow​(boolean v)
    • getShadowColor

      public NSObject getShadowColor()
    • setShadowColor

      public void setShadowColor​(NSObject v)
    • getShadowRadius

      public double getShadowRadius()
    • setShadowRadius

      public void setShadowRadius​(double v)
    • getShadowMapSize

      public CGSize getShadowMapSize()
    • setShadowMapSize

      public void setShadowMapSize​(CGSize v)
    • getShadowSampleCount

      public long getShadowSampleCount()
    • setShadowSampleCount

      public void setShadowSampleCount​(long v)
    • getShadowMode

      public SCNShadowMode getShadowMode()
    • setShadowMode

      public void setShadowMode​(SCNShadowMode v)
    • getShadowBias

      public double getShadowBias()
    • setShadowBias

      public void setShadowBias​(double v)
    • automaticallyAdjustsShadowProjection

      public boolean automaticallyAdjustsShadowProjection()
      Since:
      Available in iOS 11.0 and later.
    • setAutomaticallyAdjustsShadowProjection

      public void setAutomaticallyAdjustsShadowProjection​(boolean v)
      Since:
      Available in iOS 11.0 and later.
    • getMaximumShadowDistance

      public double getMaximumShadowDistance()
      Since:
      Available in iOS 11.0 and later.
    • setMaximumShadowDistance

      public void setMaximumShadowDistance​(double v)
      Since:
      Available in iOS 11.0 and later.
    • isForcesBackFaceCasters

      public boolean isForcesBackFaceCasters()
      Since:
      Available in iOS 11.0 and later.
    • setForcesBackFaceCasters

      public void setForcesBackFaceCasters​(boolean v)
      Since:
      Available in iOS 11.0 and later.
    • isSampleDistributedShadowMaps

      public boolean isSampleDistributedShadowMaps()
      Since:
      Available in iOS 11.0 and later.
    • setSampleDistributedShadowMaps

      public void setSampleDistributedShadowMaps​(boolean v)
      Since:
      Available in iOS 11.0 and later.
    • getShadowCascadeCount

      public long getShadowCascadeCount()
      Since:
      Available in iOS 11.0 and later.
    • setShadowCascadeCount

      public void setShadowCascadeCount​(long v)
      Since:
      Available in iOS 11.0 and later.
    • getShadowCascadeSplittingFactor

      public double getShadowCascadeSplittingFactor()
      Since:
      Available in iOS 11.0 and later.
    • setShadowCascadeSplittingFactor

      public void setShadowCascadeSplittingFactor​(double v)
      Since:
      Available in iOS 11.0 and later.
    • getOrthographicScale

      public double getOrthographicScale()
    • setOrthographicScale

      public void setOrthographicScale​(double v)
    • getZNear

      public double getZNear()
    • setZNear

      public void setZNear​(double v)
    • getZFar

      public double getZFar()
    • setZFar

      public void setZFar​(double v)
    • getAttenuationStartDistance

      public double getAttenuationStartDistance()
    • setAttenuationStartDistance

      public void setAttenuationStartDistance​(double v)
    • getAttenuationEndDistance

      public double getAttenuationEndDistance()
    • setAttenuationEndDistance

      public void setAttenuationEndDistance​(double v)
    • getAttenuationFalloffExponent

      public double getAttenuationFalloffExponent()
    • setAttenuationFalloffExponent

      public void setAttenuationFalloffExponent​(double v)
    • getSpotInnerAngle

      public double getSpotInnerAngle()
    • setSpotInnerAngle

      public void setSpotInnerAngle​(double v)
    • getSpotOuterAngle

      public double getSpotOuterAngle()
    • setSpotOuterAngle

      public void setSpotOuterAngle​(double v)
    • getIESProfileURL

      public NSURL getIESProfileURL()
      Since:
      Available in iOS 10.0 and later.
    • setIESProfileURL

      public void setIESProfileURL​(NSURL v)
      Since:
      Available in iOS 10.0 and later.
    • getSphericalHarmonicsCoefficients

      public NSData getSphericalHarmonicsCoefficients()
      Since:
      Available in iOS 11.0 and later.
    • getProbeType

      public SCNLightProbeType getProbeType()
      Since:
      Available in iOS 13.0 and later.
    • setProbeType

      public void setProbeType​(SCNLightProbeType v)
      Since:
      Available in iOS 13.0 and later.
    • getProbeUpdateType

      public SCNLightProbeUpdateType getProbeUpdateType()
      Since:
      Available in iOS 13.0 and later.
    • setProbeUpdateType

      public void setProbeUpdateType​(SCNLightProbeUpdateType v)
      Since:
      Available in iOS 13.0 and later.
    • getProbeExtents

      public VectorFloat3 getProbeExtents()
      Since:
      Available in iOS 13.0 and later.
    • setProbeExtents

      public void setProbeExtents​(VectorFloat3 v)
      Since:
      Available in iOS 13.0 and later.
    • getProbeOffset

      public VectorFloat3 getProbeOffset()
      Since:
      Available in iOS 13.0 and later.
    • setProbeOffset

      public void setProbeOffset​(VectorFloat3 v)
      Since:
      Available in iOS 13.0 and later.
    • isParallaxCorrectionEnabled

      public boolean isParallaxCorrectionEnabled()
      Since:
      Available in iOS 13.0 and later.
    • setParallaxCorrectionEnabled

      public void setParallaxCorrectionEnabled​(boolean v)
      Since:
      Available in iOS 13.0 and later.
    • getParallaxExtentsFactor

      public VectorFloat3 getParallaxExtentsFactor()
      Since:
      Available in iOS 13.0 and later.
    • setParallaxExtentsFactor

      public void setParallaxExtentsFactor​(VectorFloat3 v)
      Since:
      Available in iOS 13.0 and later.
    • getParallaxCenterOffset

      public VectorFloat3 getParallaxCenterOffset()
      Since:
      Available in iOS 13.0 and later.
    • setParallaxCenterOffset

      public void setParallaxCenterOffset​(VectorFloat3 v)
      Since:
      Available in iOS 13.0 and later.
    • getProbeEnvironment

      public SCNMaterialProperty getProbeEnvironment()
      Since:
      Available in iOS 12.0 and later.
    • getAreaType

      public SCNLightAreaType getAreaType()
      Since:
      Available in iOS 13.0 and later.
    • setAreaType

      public void setAreaType​(SCNLightAreaType v)
      Since:
      Available in iOS 13.0 and later.
    • getAreaExtents

      public VectorFloat3 getAreaExtents()
      Since:
      Available in iOS 13.0 and later.
    • setAreaExtents

      public void setAreaExtents​(VectorFloat3 v)
      Since:
      Available in iOS 13.0 and later.
    • getAreaPolygonVertices

      public NSArray<NSValue> getAreaPolygonVertices()
      Since:
      Available in iOS 13.0 and later.
    • setAreaPolygonVertices

      public void setAreaPolygonVertices​(NSArray<NSValue> v)
      Since:
      Available in iOS 13.0 and later.
    • drawsArea

      public boolean drawsArea()
      Since:
      Available in iOS 13.0 and later.
    • setDrawsArea

      public void setDrawsArea​(boolean v)
      Since:
      Available in iOS 13.0 and later.
    • isDoubleSided

      public boolean isDoubleSided()
      Since:
      Available in iOS 13.0 and later.
    • setDoubleSided

      public void setDoubleSided​(boolean v)
      Since:
      Available in iOS 13.0 and later.
    • getGobo

      public SCNMaterialProperty getGobo()
    • getCategoryBitMask

      public long getCategoryBitMask()
    • setCategoryBitMask

      public void setCategoryBitMask​(long v)
    • getAnimationKeys

      public NSArray<NSString> getAnimationKeys()
      Specified by:
      getAnimationKeys in interface SCNAnimatable
    • supportsSecureCoding

      public static boolean supportsSecureCoding()
    • getTechnique

      public SCNTechnique getTechnique()
      Specified by:
      getTechnique in interface SCNTechniqueSupport
    • setTechnique

      public void setTechnique​(SCNTechnique v)
      Specified by:
      setTechnique in interface SCNTechniqueSupport
    • create

      public static SCNLight create()
    • addAnimation

      public void addAnimation​(SCNAnimationProtocol animation, String key)
      Specified by:
      addAnimation in interface SCNAnimatable
    • addAnimationPlayer

      public void addAnimationPlayer​(SCNAnimationPlayer player, String key)
      Specified by:
      addAnimationPlayer in interface SCNAnimatable
      Since:
      Available in iOS 11.0 and later.
    • removeAllAnimations

      public void removeAllAnimations()
      Specified by:
      removeAllAnimations in interface SCNAnimatable
    • removeAllAnimations

      public void removeAllAnimations​(double duration)
      Specified by:
      removeAllAnimations in interface SCNAnimatable
      Since:
      Available in iOS 15.0 and later.
    • removeAnimation

      public void removeAnimation​(String key)
      Specified by:
      removeAnimation in interface SCNAnimatable
    • removeAnimationForKey

      public void removeAnimationForKey​(String key, double duration)
      Specified by:
      removeAnimationForKey in interface SCNAnimatable
      Since:
      Available in iOS 11.0 and later.
    • animationPlayerForKey

      public SCNAnimationPlayer animationPlayerForKey​(String key)
      Specified by:
      animationPlayerForKey in interface SCNAnimatable
      Since:
      Available in iOS 11.0 and later.
    • removeAnimation

      @Deprecated public void removeAnimation​(String key, double duration)
      Deprecated.
      Deprecated in iOS 11.0. Use -removeAnimationForKey:blendOutDuration:
      Specified by:
      removeAnimation in interface SCNAnimatable
    • getAnimation

      @Deprecated public CAAnimation getAnimation​(String key)
      Deprecated.
      Deprecated in iOS 11.0. Use -animationPlayerForKey:
      Specified by:
      getAnimation in interface SCNAnimatable
    • pauseAnimation

      @Deprecated public void pauseAnimation​(String key)
      Deprecated.
      Deprecated in iOS 11.0. Use -[SCNAnimationPlayer setPaused:] instead
      Specified by:
      pauseAnimation in interface SCNAnimatable
    • resumeAnimation

      @Deprecated public void resumeAnimation​(String key)
      Deprecated.
      Deprecated in iOS 11.0. Use -[SCNAnimationPlayer setPaused:] instead
      Specified by:
      resumeAnimation in interface SCNAnimatable
    • setSpeed

      @Deprecated public void setSpeed​(double speed, String key)
      Deprecated.
      Deprecated in iOS 11.0. Use -[SCNAnimationPlayer setSpeed:] instead
      Specified by:
      setSpeed in interface SCNAnimatable
      Since:
      Available in iOS 10.0 and later.
    • isAnimationPaused

      @Deprecated public boolean isAnimationPaused​(String key)
      Deprecated.
      Deprecated in iOS 11.0. Use -[SCNAnimationPlayer paused] instead
      Specified by:
      isAnimationPaused in interface SCNAnimatable
    • encode

      public void encode​(NSCoder coder)
      Specified by:
      encode in interface NSCoding
    • init

      protected long init​(NSCoder coder)