Class SCNLight

    • Constructor Detail

      • SCNLight

        protected SCNLight​(org.moe.natj.general.Pointer peer)
    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()
      • alloc

        public static SCNLight alloc()
      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)
      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)
      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)
      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                                 org.moe.natj.objc.SEL aSelector,
                                                                                 java.lang.Object anArgument)
      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()
      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()
      • debugDescription_static

        public static java.lang.String debugDescription_static()
      • description_static

        public static java.lang.String description_static()
      • hash_static

        public static long hash_static()
      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)
      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)
      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)
      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)
      • light

        public static SCNLight light()
        light Creates and returns a light instance.
      • lightWithMDLLight

        public static SCNLight lightWithMDLLight​(MDLLight mdlLight)
      • new_objc

        public static java.lang.Object new_objc()
      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)
      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)
      • setVersion_static

        public static void setVersion_static​(long aVersion)
      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()
      • supportsSecureCoding

        public static boolean supportsSecureCoding()
      • version_static

        public static long version_static()
      • IESProfileURL

        public NSURL IESProfileURL()
        [@property] IESProfileURL Specifies the IES file from which the shape, direction, and intensity of illumination is determined. Defaults to nil.
      • addAnimationForKey

        public void addAnimationForKey​(SCNAnimation animation,
                                       java.lang.String key)
        Description copied from interface: SCNAnimatable
        addAnimation:forKey: Adds and runs an animation Only SCNAnimation (preferred), CABasicAnimation, CAKeyframeAnimation and CAAnimationGroup are supported. The animation starts playing right away. The animation is automatically removed on completion unless if removedOnCompletion is explicitly set to NO.
        Specified by:
        addAnimationForKey in interface SCNAnimatable
        Parameters:
        animation - Added animation.
        key - May be any string such that only one animation per unique key is added per animatable object.
      • animationForKey

        public CAAnimation animationForKey​(java.lang.String key)
        Description copied from interface: SCNAnimatable
        animationForKey: Returns the animation with the given identifier This will return nil if no such animation exists. Attempting to modify any properties of the returned object will result in undefined behavior.
        Specified by:
        animationForKey in interface SCNAnimatable
        Parameters:
        key - The identifier for the animation to retrieve.
      • animationKeys

        public NSArray<java.lang.String> animationKeys()
        Description copied from interface: SCNAnimatable
        [@property] animationKeys Returns an array containing the keys of all animations currently attached to the receiver.
        Specified by:
        animationKeys in interface SCNAnimatable
      • attenuationEndDistance

        public double attenuationEndDistance()
        [@property] attenuationEndDistance The distance at which the attenuation ends (Omni or Spot light types only). Animatable. Defaults to 0.
      • attenuationFalloffExponent

        public double attenuationFalloffExponent()
        [@property] attenuationFalloffExponent Specifies the attenuation between the start and end attenuation distances. 0 means a constant attenuation, 1 a linear attenuation and 2 a quadratic attenuation, but any positive value will work (Omni or Spot light types only). Animatable. Defaults to 2.
      • attenuationStartDistance

        public double attenuationStartDistance()
        [@property] attenuationStartDistance The distance at which the attenuation starts (Omni or Spot light types only). Animatable. Defaults to 0.
      • castsShadow

        public boolean castsShadow()
        [@property] castsShadow Determines whether the receiver casts a shadow. Defaults to NO. Shadows are only supported by spot and directional lights.
      • categoryBitMask

        public long categoryBitMask()
        [@property] categoryBitMask Determines the node categories that will be lit by the receiver. Defaults to all bit set.
      • color

        public java.lang.Object color()
        [@property] color Specifies the receiver's color (NSColor or CGColorRef). Animatable. Defaults to white. The initial value is a NSColor. The renderer multiplies the light's color is by the color derived from the light's temperature.
      • copyWithZone

        public java.lang.Object copyWithZone​(org.moe.natj.general.ptr.VoidPtr zone)
        Specified by:
        copyWithZone in interface NSCopying
      • gobo

        public SCNMaterialProperty gobo()
        [@property] gobo Specifies the gobo (or "cookie") of the light, used to control the shape of emitted light. Gobos are only supported by spot lights.
      • intensity

        public double intensity()
        [@property] intensity Specifies the receiver's intensity. This intensity is used to modulate the light color. When used with a physically-based material, this corresponds to the luminous flux of the light, expressed in lumens (lm). Defaults to 1000. Animatable.
      • isAnimationForKeyPaused

        public boolean isAnimationForKeyPaused​(java.lang.String key)
        Description copied from interface: SCNAnimatable
        isAnimationForKeyPaused: Returns whether the animation for the specified identifier is paused.
        Specified by:
        isAnimationForKeyPaused in interface SCNAnimatable
        Parameters:
        key - The identifier for the animation to query.
      • name

        public java.lang.String name()
        [@property] name Determines the name of the receiver.
      • orthographicScale

        public double orthographicScale()
        [@property] orthographicScale Specifies the orthographic scale used to render from the directional light into the shadow map. Defaults to 1. This is only applicable for directional lights.
      • pauseAnimationForKey

        public void pauseAnimationForKey​(java.lang.String key)
        Description copied from interface: SCNAnimatable
        pauseAnimationForKey: Pause the animation with the given identifier.
        Specified by:
        pauseAnimationForKey in interface SCNAnimatable
        Parameters:
        key - The identifier for the animation to pause.
      • removeAnimationForKey

        public void removeAnimationForKey​(java.lang.String key)
        Description copied from interface: SCNAnimatable
        removeAnimationForKey Remove the animation with the given identifier.
        Specified by:
        removeAnimationForKey in interface SCNAnimatable
        Parameters:
        key - The identifier for the animation to remove.
      • removeAnimationForKeyFadeOutDuration

        public void removeAnimationForKeyFadeOutDuration​(java.lang.String key,
                                                         double duration)
        Description copied from interface: SCNAnimatable
        removeAnimationForKey:fadeOutDuration: Smoothly remove the animation with the given identifier.
        Specified by:
        removeAnimationForKeyFadeOutDuration in interface SCNAnimatable
        Parameters:
        key - The identifier for the animation to remove.
        duration - The fade out duration used to remove the animation.
      • resumeAnimationForKey

        public void resumeAnimationForKey​(java.lang.String key)
        Description copied from interface: SCNAnimatable
        resumeAnimationForKey: Resume the animation with the given identifier.
        Specified by:
        resumeAnimationForKey in interface SCNAnimatable
        Parameters:
        key - The identifier for the animation to resume.
      • setAttenuationEndDistance

        public void setAttenuationEndDistance​(double value)
        [@property] attenuationEndDistance The distance at which the attenuation ends (Omni or Spot light types only). Animatable. Defaults to 0.
      • setAttenuationFalloffExponent

        public void setAttenuationFalloffExponent​(double value)
        [@property] attenuationFalloffExponent Specifies the attenuation between the start and end attenuation distances. 0 means a constant attenuation, 1 a linear attenuation and 2 a quadratic attenuation, but any positive value will work (Omni or Spot light types only). Animatable. Defaults to 2.
      • setAttenuationStartDistance

        public void setAttenuationStartDistance​(double value)
        [@property] attenuationStartDistance The distance at which the attenuation starts (Omni or Spot light types only). Animatable. Defaults to 0.
      • setCastsShadow

        public void setCastsShadow​(boolean value)
        [@property] castsShadow Determines whether the receiver casts a shadow. Defaults to NO. Shadows are only supported by spot and directional lights.
      • setCategoryBitMask

        public void setCategoryBitMask​(long value)
        [@property] categoryBitMask Determines the node categories that will be lit by the receiver. Defaults to all bit set.
      • setColor

        public void setColor​(java.lang.Object value)
        [@property] color Specifies the receiver's color (NSColor or CGColorRef). Animatable. Defaults to white. The initial value is a NSColor. The renderer multiplies the light's color is by the color derived from the light's temperature.
      • setIESProfileURL

        public void setIESProfileURL​(NSURL value)
        [@property] IESProfileURL Specifies the IES file from which the shape, direction, and intensity of illumination is determined. Defaults to nil.
      • setIntensity

        public void setIntensity​(double value)
        [@property] intensity Specifies the receiver's intensity. This intensity is used to modulate the light color. When used with a physically-based material, this corresponds to the luminous flux of the light, expressed in lumens (lm). Defaults to 1000. Animatable.
      • setName

        public void setName​(java.lang.String value)
        [@property] name Determines the name of the receiver.
      • setOrthographicScale

        public void setOrthographicScale​(double value)
        [@property] orthographicScale Specifies the orthographic scale used to render from the directional light into the shadow map. Defaults to 1. This is only applicable for directional lights.
      • setShadowBias

        public void setShadowBias​(double value)
        [@property] shadowBias Specifies the correction to apply to the shadow map to correct acne artefacts. It is multiplied by an implementation-specific value to create a constant depth offset. Defaults to 1.0
      • setShadowColor

        public void setShadowColor​(java.lang.Object value)
        [@property] shadowColor Specifies the color (CGColorRef or NSColor) of the shadow casted by the receiver. Defaults to black. Animatable. On iOS 9 or earlier and macOS 10.11 or earlier, this defaults to black 50% transparent.
      • setShadowMapSize

        public void setShadowMapSize​(CGSize value)
        [@property] shadowMapSize Specifies the size of the shadow map. The larger the shadow map is the more precise the shadows are but the slower the computation is. If set to {0,0} the size of the shadow map is automatically chosen. Defaults to {0,0}.
      • setShadowMode

        public void setShadowMode​(long value)
        [@property] shadowMode Specified the mode to use to cast shadows. See above for the available modes and their description. Defaults to SCNShadowModeForward.
      • setShadowRadius

        public void setShadowRadius​(double value)
        [@property] shadowRadius Specifies the sample radius used to render the receiver’s shadow. Default value is 3.0. Animatable.
      • setShadowSampleCount

        public void setShadowSampleCount​(long value)
        [@property] shadowSampleCount Specifies the number of sample per fragment to compute the shadow map. Defaults to 0. On macOS 10.11 or earlier, the shadowSampleCount defaults to 16. On iOS 9 or earlier it defaults to 1.0. On macOS 10.12, iOS 10 and greater, when the shadowSampleCount is set to 0, a default sample count is chosen depending on the platform.
      • setSpeedForAnimationKey

        public void setSpeedForAnimationKey​(double speed,
                                            java.lang.String key)
        Description copied from interface: SCNAnimatable
        setSpeed:forAnimationKey: Update the animation speed of the animation with the given identifier.
        Specified by:
        setSpeedForAnimationKey in interface SCNAnimatable
        Parameters:
        speed - The new speed of the animation.
        key - The identifier for the animation to update.
      • setSpotInnerAngle

        public void setSpotInnerAngle​(double value)
        [@property] spotInnerAngle The angle in degrees between the spot direction and the lit element below which the lighting is at full strength. Animatable. Defaults to 0.
      • setSpotOuterAngle

        public void setSpotOuterAngle​(double value)
        [@property] spotOuterAngle The angle in degrees between the spot direction and the lit element after which the lighting is at zero strength. Animatable. Defaults to 45 degrees.
      • setTemperature

        public void setTemperature​(double value)
        [@property] temperature Specifies the receiver's temperature. This specifies the temperature of the light in Kelvin. The renderer multiplies the light's color by the color derived from the light's temperature. Defaults to 6500 (pure white). Animatable.
      • setType

        public void setType​(java.lang.String value)
        [@property] type Specifies the receiver's type. Defaults to SCNLightTypeOmni on iOS 8 and later, and on macOS 10.10 and later (otherwise defaults to SCNLightTypeAmbient).
      • setZFar

        public void setZFar​(double value)
        [@property] zFar Specifies the maximal distance between the light and a visible surface to cast shadow on. If a surface is further from the light than this maximal distance, then the surface won't be shadowed. Animatable. Defaults to 100.
      • setZNear

        public void setZNear​(double value)
        [@property] zNear Specifies the minimal distance between the light and the surface to cast shadow on. If a surface is closer to the light than this minimal distance, then the surface won't be shadowed. The near value must be different than zero. Animatable. Defaults to 1.
      • shadowBias

        public double shadowBias()
        [@property] shadowBias Specifies the correction to apply to the shadow map to correct acne artefacts. It is multiplied by an implementation-specific value to create a constant depth offset. Defaults to 1.0
      • shadowColor

        public java.lang.Object shadowColor()
        [@property] shadowColor Specifies the color (CGColorRef or NSColor) of the shadow casted by the receiver. Defaults to black. Animatable. On iOS 9 or earlier and macOS 10.11 or earlier, this defaults to black 50% transparent.
      • shadowMapSize

        public CGSize shadowMapSize()
        [@property] shadowMapSize Specifies the size of the shadow map. The larger the shadow map is the more precise the shadows are but the slower the computation is. If set to {0,0} the size of the shadow map is automatically chosen. Defaults to {0,0}.
      • shadowMode

        public long shadowMode()
        [@property] shadowMode Specified the mode to use to cast shadows. See above for the available modes and their description. Defaults to SCNShadowModeForward.
      • shadowRadius

        public double shadowRadius()
        [@property] shadowRadius Specifies the sample radius used to render the receiver’s shadow. Default value is 3.0. Animatable.
      • shadowSampleCount

        public long shadowSampleCount()
        [@property] shadowSampleCount Specifies the number of sample per fragment to compute the shadow map. Defaults to 0. On macOS 10.11 or earlier, the shadowSampleCount defaults to 16. On iOS 9 or earlier it defaults to 1.0. On macOS 10.12, iOS 10 and greater, when the shadowSampleCount is set to 0, a default sample count is chosen depending on the platform.
      • spotInnerAngle

        public double spotInnerAngle()
        [@property] spotInnerAngle The angle in degrees between the spot direction and the lit element below which the lighting is at full strength. Animatable. Defaults to 0.
      • spotOuterAngle

        public double spotOuterAngle()
        [@property] spotOuterAngle The angle in degrees between the spot direction and the lit element after which the lighting is at zero strength. Animatable. Defaults to 45 degrees.
      • _supportsSecureCoding

        public boolean _supportsSecureCoding()
        Description copied from interface: NSSecureCoding
        This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
        Specified by:
        _supportsSecureCoding in interface NSSecureCoding
      • temperature

        public double temperature()
        [@property] temperature Specifies the receiver's temperature. This specifies the temperature of the light in Kelvin. The renderer multiplies the light's color by the color derived from the light's temperature. Defaults to 6500 (pure white). Animatable.
      • type

        public java.lang.String type()
        [@property] type Specifies the receiver's type. Defaults to SCNLightTypeOmni on iOS 8 and later, and on macOS 10.10 and later (otherwise defaults to SCNLightTypeAmbient).
      • zFar

        public double zFar()
        [@property] zFar Specifies the maximal distance between the light and a visible surface to cast shadow on. If a surface is further from the light than this maximal distance, then the surface won't be shadowed. Animatable. Defaults to 100.
      • zNear

        public double zNear()
        [@property] zNear Specifies the minimal distance between the light and the surface to cast shadow on. If a surface is closer to the light than this minimal distance, then the surface won't be shadowed. The near value must be different than zero. Animatable. Defaults to 1.
      • addAnimationPlayerForKey

        public void addAnimationPlayerForKey​(SCNAnimationPlayer player,
                                             java.lang.String key)
        Description copied from interface: SCNAnimatable
        addAnimationPlayer:forKey: Add an animation player. The animation player is not removed automatically on completion. The animation doesn't start playing immediatelly. Call "play" on the player to start playing it.
        Specified by:
        addAnimationPlayerForKey in interface SCNAnimatable
        Parameters:
        player - Added animation player.
        key - May be any string such that only one animation per unique key is added per animatable object.
      • animationPlayerForKey

        public SCNAnimationPlayer animationPlayerForKey​(java.lang.String key)
        Description copied from interface: SCNAnimatable
        animationPlayerForKey: Returns the animation player with the given identifier This will return nil if no such animation player exists.
        Specified by:
        animationPlayerForKey in interface SCNAnimatable
        Parameters:
        key - The identifier for the animation player to retrieve.
      • automaticallyAdjustsShadowProjection

        public boolean automaticallyAdjustsShadowProjection()
        [@property] automaticallyAdjustsShadowProjection Specifies if the shadow map projection should be done automatically or manually by the user. Defaults to YES.
      • forcesBackFaceCasters

        public boolean forcesBackFaceCasters()
        [@property] forcesBackFaceCasters Render only back faces of the shadow caster when enabled. Defaults to NO. This is a behavior change from previous releases.
      • maximumShadowDistance

        public double maximumShadowDistance()
        [@property] maximumShadowDistance Specifies the maximum distance from the viewpoint from which the shadows for the receiver light won't be computed. Defaults to 100.0.
      • removeAnimationForKeyBlendOutDuration

        public void removeAnimationForKeyBlendOutDuration​(java.lang.String key,
                                                          double duration)
        Description copied from interface: SCNAnimatable
        Smoothly remove the animation with the given identifier.
        Specified by:
        removeAnimationForKeyBlendOutDuration in interface SCNAnimatable
        Parameters:
        key - The identifier for the animation to remove.
        duration - The blend out duration used to remove the animation.
      • sampleDistributedShadowMaps

        public boolean sampleDistributedShadowMaps()
        [@property] sampleDistributedShadowMaps Use the sample distribution of the main rendering to better fit the shadow frusta. Defaults to NO.
      • setAutomaticallyAdjustsShadowProjection

        public void setAutomaticallyAdjustsShadowProjection​(boolean value)
        [@property] automaticallyAdjustsShadowProjection Specifies if the shadow map projection should be done automatically or manually by the user. Defaults to YES.
      • setForcesBackFaceCasters

        public void setForcesBackFaceCasters​(boolean value)
        [@property] forcesBackFaceCasters Render only back faces of the shadow caster when enabled. Defaults to NO. This is a behavior change from previous releases.
      • setMaximumShadowDistance

        public void setMaximumShadowDistance​(double value)
        [@property] maximumShadowDistance Specifies the maximum distance from the viewpoint from which the shadows for the receiver light won't be computed. Defaults to 100.0.
      • setSampleDistributedShadowMaps

        public void setSampleDistributedShadowMaps​(boolean value)
        [@property] sampleDistributedShadowMaps Use the sample distribution of the main rendering to better fit the shadow frusta. Defaults to NO.
      • setShadowCascadeCount

        public void setShadowCascadeCount​(long value)
        [@property] shadowCascadeCount Specifies the number of distinct shadow maps that will be computed for the receiver light. Defaults to 1. Maximum is 4.
      • setShadowCascadeSplittingFactor

        public void setShadowCascadeSplittingFactor​(double value)
        [@property] shadowCascadeSplittingFactor Specifies a factor to interpolate between linear splitting (0) and logarithmic splitting (1). Defaults to 0.15.
      • shadowCascadeCount

        public long shadowCascadeCount()
        [@property] shadowCascadeCount Specifies the number of distinct shadow maps that will be computed for the receiver light. Defaults to 1. Maximum is 4.
      • shadowCascadeSplittingFactor

        public double shadowCascadeSplittingFactor()
        [@property] shadowCascadeSplittingFactor Specifies a factor to interpolate between linear splitting (0) and logarithmic splitting (1). Defaults to 0.15.
      • sphericalHarmonicsCoefficients

        public NSData sphericalHarmonicsCoefficients()
        [@property] sphericalHarmonicsCoefficients The receiver's spherical harmonics coefficients. Currently spherical harmonics are only supported by light probes (SCNLightTypeProbe). The data is an array of 27 32-bit floating-point values, containing three non-interleaved data sets corresponding to the red, green, and blue sets of coefficients.
      • areaPolygonVertices

        public NSArray<? extends NSValue> areaPolygonVertices()
        [@property] areaPolygonVertices Determines the shape of light of an area light of type SCNLightAreaTypePolygon. Defaults nil. An array of CGPoint values corresponding to the coordinates of the polygon's vertices in the XY plane.
      • areaType

        public long areaType()
        [@property] areaType Determines the shape of a light of type SCNLightTypeArea. Defaults to SCNLightAreaTypeRectangle.
      • doubleSided

        public boolean doubleSided()
        [@property] doubleSided Determines whether a light of type SCNLightTypeArea is double-sided. Defaults NO. Area lights of type SCNLightAreaTypeRectangle or SCNLightAreaTypePolygon emit light along the -Z axis. When set to YES, they also emit light along the +Z axis.
      • drawsArea

        public boolean drawsArea()
        [@property] drawsArea Determines whether the shape of a light of type SCNLightTypeArea is drawn in the scene. Defaults to YES.
      • parallaxCorrectionEnabled

        public boolean parallaxCorrectionEnabled()
        Whether parallax correction is enabled for the reflection probe. Defaults to NO.
      • probeEnvironment

        public SCNMaterialProperty probeEnvironment()
        Only applies to a probe of type SCNLightProbeTypeRadiance.
      • probeType

        public long probeType()
        Type of the probe. Defaults to SCNLightProbeTypeIrradiance.
      • probeUpdateType

        public long probeUpdateType()
        Update type of the probe. Defaults to SCNLightProbeUpdateTypeNever.
      • setAreaPolygonVertices

        public void setAreaPolygonVertices​(NSArray<? extends NSValue> value)
        [@property] areaPolygonVertices Determines the shape of light of an area light of type SCNLightAreaTypePolygon. Defaults nil. An array of CGPoint values corresponding to the coordinates of the polygon's vertices in the XY plane.
      • setAreaType

        public void setAreaType​(long value)
        [@property] areaType Determines the shape of a light of type SCNLightTypeArea. Defaults to SCNLightAreaTypeRectangle.
      • setDoubleSided

        public void setDoubleSided​(boolean value)
        [@property] doubleSided Determines whether a light of type SCNLightTypeArea is double-sided. Defaults NO. Area lights of type SCNLightAreaTypeRectangle or SCNLightAreaTypePolygon emit light along the -Z axis. When set to YES, they also emit light along the +Z axis.
      • setDrawsArea

        public void setDrawsArea​(boolean value)
        [@property] drawsArea Determines whether the shape of a light of type SCNLightTypeArea is drawn in the scene. Defaults to YES.
      • setParallaxCorrectionEnabled

        public void setParallaxCorrectionEnabled​(boolean value)
        Whether parallax correction is enabled for the reflection probe. Defaults to NO.
      • setProbeType

        public void setProbeType​(long value)
        Type of the probe. Defaults to SCNLightProbeTypeIrradiance.
      • setProbeUpdateType

        public void setProbeUpdateType​(long value)
        Update type of the probe. Defaults to SCNLightProbeUpdateTypeNever.