SCNLight Class

Reference

Definition

Namespace:: SceneKit

Assembly:: Xamarin.iOS.dll

Assembly:: Xamarin.Mac.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A light source, used for all SCNLightTypes.

[Foundation.Register("SCNLight", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class SCNLight : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposable, SceneKit.ISCNAnimatable, SceneKit.ISCNTechniqueSupport

[Foundation.Register("SCNLight", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 8, ObjCRuntime.PlatformArchitecture.All, null)]
public class SCNLight : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposable, SceneKit.ISCNAnimatable, SceneKit.ISCNTechniqueSupport

type SCNLight = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSSecureCoding
    interface ISCNAnimatable
    interface ISCNTechniqueSupport

Inheritance: Object

NSObject
SCNLight

Attributes: RegisterAttribute IntroducedAttribute

Implements: INSCoding INSCopying INSSecureCoding INativeObject ISCNAnimatable ISCNTechniqueSupport IDisposable

Constructors

SCNLight()	Default constructor, initializes a new instance of this class.
SCNLight(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
SCNLight(NSCoder)	A constructor that initializes the object from the data stored in the unarchiver object.
SCNLight(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AttenuationEndDistance	Gets or sets the maximum distance that the light will shine.
AttenuationFalloffExponent	Gets or sets a value that controls the rate at which illumination from the light falls off.
AttenuationStartDistance	Gets or sets the distance from the light source at which attenuation begins.
AutomaticallyAdjustsShadowProjection
CastsShadow	Gets or sets a value that controls whether the light casts shadows.
CategoryBitMask	Gets or sets a bitmask that controls the categories to which the light belongs.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
Color	Gets or sets the color of the light.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
ForcesBackFaceCasters
Gobo	Gets or sets a geometric stencil for the light.
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IesProfileUrl	Gets the URL for photometry data for the light, if present.
Intensity	Gets or sets the light intensity.
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
LightType	Gets or sets the light type.
MaximumShadowDistance
Name	Gets or sets a name for the light.
OrthographicScale	Gets or sets a value that limits the extent of the lights shadow map.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
SampleDistributedShadowMaps
Self	(Inherited from NSObject)
ShadowBias	Gets or sets the degree of shadow correction.
ShadowCascadeCount
ShadowCascadeSplittingFactor
ShadowColor	Gets or sets the color of shadows that are cast by the light.
ShadowMapSize	Gets or sets the size of the shadow map image, which controls the clarity of shadows.
ShadowMode	Gets or sets a value that controls how and when shadows are rendered by the rendering engine.
ShadowRadius	Gets or sets the amount of shadow blurring.
ShadowSampleCount	Gets or sets the density of points to sample when creating shadows.
SphericalHarmonicsCoefficients
SpotInnerAngle	Gets or sets the angle inside of which full illumination occurs.
SpotOuterAngle	Gets or sets the angle that is partially lit.
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Technique	Gets or sets the multipass rendering technique.
Temperature	Gets or sets the light's color temperature.
WeakColor	Gets or sets a weak reference to the light color.
WeakShadowColor	Gets or sets a weak reference to the shadow color.
ZFar	Gets or sets the maximum range for which the light casts shadows.
ZNear	Gets or sets the minimum range for which the light casts shadows.
Zone	(Inherited from NSObject)

Methods

AddAnimation(CAAnimation, NSString)	Adds the specified animation, indexed by the specified key.
AddAnimation(SCNAnimationPlayer, NSString)
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (Inherited from NSObject)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
Copy(NSZone)	Performs a copy of the underlying Objective-C object.
Create()	Creates a new light.
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the NSObject object. (Inherited from NSObject)
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
EncodeTo(NSCoder)	Encodes the state of the object on the provided encoder
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
FromModelLight(MDLLight)	Creates a new Scene Kit light from the provided Model IO light.
GetAnimation(NSString)	Developers should not use this deprecated method. Developers should use 'GetAnimationPlayer' instead.
GetAnimationKeys()	Gets the list of animation keys.
GetAnimationPlayer(NSString)
GetAttribute(NSString)	Obsolete. Returns the attribute object for the name.
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsAnimationPaused(NSString)	Returns `true` if the specified animation is paused. Otherwise, it returns `false`.
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PauseAnimation(NSString)	Pauses the specified animation.
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the `obj` is not null, it passes this as its single parameter. (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveAllAnimations()	Removes all animations from the light.
RemoveAnimation(NSString, nfloat)	Fades the specified animation out from the light over the specified duration, and removes it.
RemoveAnimation(NSString)	Removes the specified animation.
RemoveAnimationUsingBlendOutDuration(NSString, nfloat)
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
ResumeAnimation(NSString)	Resumes the specified animation.
SetAttribute(NSObject, NSString)	Obsolete. Sets the specified attribute to the specified value.
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetSpeed(nfloat, NSString)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	Obsolete. (Inherited from NSObject)
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
AddAnimation(ISCNAnimatable, SCNAnimationPlayer, NSString)
GetAnimationPlayer(ISCNAnimatable, NSString)
RemoveAnimationUsingBlendOutDuration(ISCNAnimatable, NSString, nfloat)
SetSpeed(ISCNAnimatable, nfloat, NSString)	Developers should not use this deprecated method. Developers should use 'SCNAnimationPlayer.Speed' instead.
AddAnimation(ISCNAnimatable, SCNAnimation, String)	Adds the specified animation and associates it with the specified key.
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.

Applies to

Share via