Platforms to show: All Mac Windows Linux Cross-Platform

Back to SCNLightMBS class.

SCNLightMBS.attenuationEndDistance as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The distance from the light at which its intensity is completely diminished. Animatable.

You can apply attenuation to omnidirectional lights and spotlights, causing their intensity to diminish over a specified range of distances. At distances less than the start distance, the light’s illumination is at full intensity. At distances greater than the end distance, the light provides no illumination. At distances in between the start and end distance, the attenuationFalloffExponent property defines the transition from full illumination to no illumination.
The default value is 0.0, specifying no attenuation (the light’s intensity is the same at all distances).
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

SCNLightMBS.attenuationFalloffExponent as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The transition curve for the light’s intensity between its attenuation start and end distances. Animatable.

You can apply attenuation to omnidirectional lights and spotlights, causing their intensity to diminish over a specified range of distances. At distances in between the start and end distance, the light’s intensity transitions from full to no illumination according to the value of this property.
A value of 0.0 specifies no attenuation—the light’s intensity is the same at all distances. A value of 1.0 specifies a linear transition, and a value of 2.0 (the default) specifies a quadratic transition curve. Higher values have little visible effect.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

SCNLightMBS.attenuationStartDistance as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The distance from the light at which its intensity begins to diminish. Animatable.

You can apply attenuation to omnidirectional lights and spotlights, causing their intensity to diminish over a specified range of distances. At distances less than the start distance, the light’s illumination is at full intensity. At distances greater than the end distance, the light provides no illumination. At distances in between the start and end distance, the attenuationFalloffExponent property defines the transition from full illumination to no illumination.
The default value is 0.0, specifying no attenuation (the light’s intensity is the same at all distances).
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

SCNLightMBS.automaticallyAdjustsShadowProjection as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Specifies if the shadow map projection should be done automatically or manually by the user.

Defaults to true.
(Read and Write property)

SCNLightMBS.CastsShadow as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A Boolean value that determines whether the light casts shadows.

Geometries illuminated by the light cast shadows only if the value of this property is true and the type property of the light is SCNLightTypeSpot or SCNLightTypeDirectional. The default value is false.
(Read and Write property)

SCNLightMBS.Color as NSColorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The color of the light. Animatable.

The value of this property is an NSColorMBS object. The default color is white.
You can animate changes to this property’s value.

See Animating SceneKit Content:
https://developer.apple.com/documentation/scenekit/animation/animating_scenekit_content
(Read and Write property)

SCNLightMBS.ForcesBackFaceCasters as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The internal object reference.

(Read and Write property)

SCNLightMBS.gobo as SCNMaterialPropertyMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 19.1 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
An image or other visual content affecting the shape and color of a light’s illuminated area.

In photographic and stage lighting terminology, a gobo (also known as a flag or cookie) is a stencil, gel, or other object placed just in front of a light source, shaping or coloring the beam of light.
You alter the appearance of a spotlight by changing the contents property of the object permanently assigned to this property. As with other material properties, you can use a color or image, or a Core Animation layer containing animated content, as a lighting gobo.
This property applies only to lights whose type property is spot.
(Read only property)

SCNLightMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The internal object reference.

(Read and Write property)

SCNLightMBS.Intensity as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The luminous flux, in lumens, or total brightness of the light. Animatable.

When working with photometric lights (see the IESProfileURL property) or physically-based rendering (see SCNLightingModelPhysicallyBased), you can leave the color property at its default white color and use the intensity and temperature to control the light using realistic parameters. When working with physically-based materials, this value the luminous flux of the light source. The default value is 1000 lumens.
When not using physically-based rendering, this value (divided by 1000) serves as a multiplier for the the color property. The default value of of 1000 leaves the light color unmodulated; you can use higher values, for example, to brighten a light whose color is already the maximum red value.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

SCNLightMBS.maximumShadowDistance as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Specifies the maximum distance from the viewpoint from which the shadows for the receiver light won't be computed.

Defaults to 100.0.
(Read and Write property)

SCNLightMBS.Name as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A name associated with the light.

You can provide a descriptive name for a light to make managing your scene graph easier. Lights loaded from a scene file may have names assigned by an artist using a 3D authoring tool. To examine lights in a scene file without loading its scene graph, use the SCNSceneSourceMBS class.
(Read and Write property)

SCNLightMBS.OrthographicScale as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The orthographic scale SceneKit uses when rendering the shadow map for a directional light.

SceneKit draws a shadow map image by rendering the scene from the point of view of the node containing the light. Directional lights ignore the position property of the node containing them because their light has a constant direction. Therefore, rendering a shadow map for a directional light requires an orthographic projection. Like the orthographicScale property of a camera object, this property specifies the extent of the scene “visible to” the light when rendering the shadow map.
This property applies only if the light’s type property is SCNLightTypeDirectional.
(Read and Write property)

SCNLightMBS.SampleDistributedShadowMaps as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Use the sample distribution of the main rendering to better fit the shadow frusta.

Defaults to false.
(Read and Write property)

SCNLightMBS.ShadowBias as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The amount of correction to apply to the shadow to prevent rendering artifacts.

Rendering shadows from a shadow map can result in artifacts where the shadow color does not appear on all pixels in a shadowed surface as intended. (This effect is typically called shadow acne.) This property specifies the error margin SceneKit uses to correct such artifacts.
The default value is 1.0.
(Read and Write property)

SCNLightMBS.ShadowCascadeCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Specifies the number of distinct shadow maps that will be computed for the receiver light.

Defaults to 1. Maximum is 4.
(Read and Write property)

SCNLightMBS.ShadowCascadeSplittingFactor as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Specifies a factor to interpolate between linear splitting (0) and logarithmic splitting (1).

Defaults to 0.15.
(Read and Write property)

SCNLightMBS.shadowColor as NSColorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The color of shadows cast by the light. Animatable.

The value of this property is an NSColorMBS object. SceneKit blends the light’s color with other colors in the rendered image to produce a shadow effect. The color’s opacity (alpha value) determines the intensity of the shadows. The default shadow color is black with 50% opacity.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

SCNLightMBS.ShadowMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The mode SceneKit uses to render shadows.

The default mode is SCNShadowModeForward in iOS and in macOS 10.10 or later. In OS X v10.9 or earlier, the default mode is SCNShadowModeDeferred.
(Read and Write property)

SCNLightMBS.ShadowRadius as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A number that specifies the amount of blurring around the edges of shadows cast by the light. Animatable.

SceneKit produces soft-edged shadows by rendering the silhouettes of geometry into a 2D shadow map and then using several weighted samples from the shadow map to determine the strength of the shadow at each pixel in the rendered scene. This property controls the radius of shadow map sampling. Lower numbers result in shadows with sharply defined, pixelated edges; higher numbers result in blurry shadows.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

SCNLightMBS.ShadowSampleCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The number of samples from the shadow map that SceneKit uses to render each pixel.

SceneKit produces soft-edged shadows by rendering the silhouettes of scene geometry into a 2D shadow map and then using several weighted samples from the shadow map to determine the strength of the shadow at each pixel in the rendered scene. This property controls the number of samples from the shadow map used to render each pixel. Higher numbers result in smoother edges; lower numbers increase rendering performance.
The default value is 16 in macOS and 1 on iOS.
(Read and Write property)

SCNLightMBS.spotInnerAngle as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The angle, in degrees, of the area fully lit by a spotlight. Animatable.

You define the cone-shaped illuminated area of a spotlight with a position and direction (from the node containing the light) and an angle specifying the cone’s width. Additionally, the illuminated area can smoothly transition from full illumination to no illumination. This property determines the width of the fully illuminated area.
The default value is 0.0, specifying that only the center of the area illuminated by the spotlight is lit at full intensity.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

Some examples using this property:

SCNLightMBS.spotOuterAngle as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The angle, in degrees, of the area partially lit by a spotlight. Animatable.

You define the cone-shaped illuminated area of a spotlight with a position and direction (from the node containing the light) and with an angle specifying the cone’s width. Additionally, the illuminated area can smoothly transition from full illumination to no illumination. This property determines the width of the transition area.
The default value is 45.0.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

Some examples using this property:

SCNLightMBS.Temperature as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The color temperature, in degrees Kelvin, of the light source. Animatable.

SceneKit determines the actual color of the light by multiplying the color value by a color corresponding to the light’s temperature. The default value of 6500 K represents a pure white light (leaving the color unmodulated); lower values (down to a minimum of zero) add a “warmer” yellow or orange effect to the light source, and higher values (up to a maximum of 40000) add a “cooler” blue effect.
This property affects all light types, but is especially useful when working with photometric lights (see the IESProfileURL property) or physically-based rendering (see SCNLightingModelPhysicallyBased). You can leave the color property at its default white color and use the intensity and temperature properties to control the light using realistic parameters.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

SCNLightMBS.Type as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A constant identifying the general behavior of the light.

A light’s type determines the shape and directionality of illumination provided by the light, as well as the set of attributes available for modifying the light’s behavior. For example, light types include omnidirectional lights and spotlights. See Light Types for the full set of types and their behaviors.

see also
https://developer.apple.com/documentation/scenekit/scnlighttype
(Read and Write property)

SCNLightMBS.zFar as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The maximum distance between the light and a visible surface for casting shadows.

A spotlight casts shadows if its castsShadow property is true. If a surface is farther from the light than this distance, shadows are not cast against the surface.
The default value is 100.0.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

SCNLightMBS.zNear as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property SceneKit MBS Mac64bit Plugin 18.5 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The minimum distance between the light and a visible surface for casting shadows. Animatable.

A spotlight casts shadows if its castsShadow property is true. If a surface is closer to the light than this distance, shadows are not cast against the surface.
The default value is 1.0.
You can animate changes to this property’s value. See Animating SceneKit Content.
(Read and Write property)

The items on this page are in the following plugins: MBS Mac64bit Plugin.


The biggest plugin in space...