SCNMaterial SCNMaterial Class

Definition

Specifies the lighting and shading characteristics of the surface of an SCNGeometry.

[Foundation.Register("SCNMaterial", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 8, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class SCNMaterial : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposable, SceneKit.ISCNAnimatable, SceneKit.ISCNShadable
type SCNMaterial = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSSecureCoding
    interface ISCNAnimatable
    interface ISCNShadable
Inheritance
SCNMaterialSCNMaterial
Attributes
Implements

Constructors

SCNMaterial() SCNMaterial()

Default constructor, initializes a new instance of this class.

SCNMaterial(IntPtr) SCNMaterial(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

SCNMaterial(NSCoder) SCNMaterial(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

SCNMaterial(NSObjectFlag) SCNMaterial(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Ambient Ambient

Gets the material property that determines how ambient light affects the material.

AmbientOcclusion AmbientOcclusion

Gets or sets the ambient occlusion value for the material.

BlendMode BlendMode

Gets or sets a value that controls how the material colors are blended into the scene.

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

ColorBufferWriteMask ColorBufferWriteMask
CullMode CullMode

Gets or sets a value that controls which faces are removed during rendering.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Diffuse Diffuse

Gets the material property that determines the material models diffuse reflection.

Displacement Displacement
DoubleSided DoubleSided

Gets or sets a value that controls whether both faces of a surface should be rendered. Default is false.

Emission Emission

Gets an object that represents the color at each point on a surface.

FillMode FillMode
FresnelExponent FresnelExponent

Gets or sets the exponent that controls how reflectivity changes with viewing angle.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
LightingModelName LightingModelName

Gets or sets the lighting model name.

LitPerPixel LitPerPixel

Gets or sets a value that controls whether lighting is performed on a per-pixel or per-vertex basis.

LocksAmbientWithDiffuse LocksAmbientWithDiffuse

Gets or sets a value that determines whether the ambient light response is locked to the diffuse light response.

Metalness Metalness

Gets or sets a value that controls how metallic the material appears.

Multiply Multiply

Gets or sets a color by which to multiply every rendered pixel.

Name Name

Gets or sets the name of the material.

Normal Normal

Gets the normal map for the surface.

Program Program

Gets the custom shader program, if any.

ReadsFromDepthBuffer ReadsFromDepthBuffer

Gets or sets a value that controls whether the renderer will read depth information when rendering the material.

Reflective Reflective

Gets the reflected color at each point on the material surface.

RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Roughness Roughness

Gets or sets the apparent surface roughness of the material.

Self Self Inherited from NSObject
SelfIllumination SelfIllumination

Gets or sets the degree to which the surface illuminates itself.

ShaderModifiers ShaderModifiers

Gets or sets a dictionary of named GLSL code snippets that are used for customizing the shaders that are provided by SceneKit.

Shininess Shininess

Gets or sets a value that controls the sharpness of specular highlights.

Specular Specular

Gets the material property that determines the material models specular reflection.

Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Transparency Transparency

Gets or sets the transparency of the material.

TransparencyMode TransparencyMode

Gets or sets a value that controls whether transparency is inferred from the alpha channel or from luminance data.

Transparent Transparent

Gets a value that describes the transparency at each point in the material.

WeakShaderModifiers WeakShaderModifiers

Gets or sets a weak reference to the shader modifiers.

WritesToDepthBuffer WritesToDepthBuffer

Gets or sets a value that controls whether SceneKit writes data to the depth buffer when rendering the material.

Zone Zone Inherited from NSObject

Methods

AddAnimation(CAAnimation, NSString) AddAnimation(CAAnimation, NSString)

Adds the specified animation, indexed by the specified key.

AddAnimation(SCNAnimationPlayer, NSString) AddAnimation(SCNAnimationPlayer, NSString)
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) 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) 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>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) Bind(NSString, NSObject, String, NSDictionary) Inherited from NSObject
Bind(String, NSObject, String, NSDictionary) Bind(String, NSObject, String, NSDictionary) Inherited from NSObject
BindingInfo(String) BindingInfo(String) Inherited from NSObject
BindingOptionDescriptions(String) BindingOptionDescriptions(String) Inherited from NSObject
BindingValueClass(String) BindingValueClass(String) Inherited from NSObject
CommitEditing() CommitEditing() Inherited from NSObject
CommitEditing(NSObject, Selector, IntPtr) CommitEditing(NSObject, Selector, IntPtr) Inherited from NSObject
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSZone) Copy(NSZone)

Performs a copy of the underlying Objective-C object.

Create() Create()

Creates a new material.

DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EncodeTo(NSCoder) EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
ExposedBindings() ExposedBindings() Inherited from NSObject
FromMaterial(MDLMaterial) FromMaterial(MDLMaterial)

Creates and returns a new Scene Kit material from the provided Model IO material.

GetAnimation(NSString) GetAnimation(NSString)

Developers should not use this deprecated method. Developers should use 'GetAnimationPlayer' instead.

GetAnimationKeys() GetAnimationKeys()

Returns the list of animation keys.

GetAnimationPlayer(NSString) GetAnimationPlayer(NSString)
GetBindingInfo(NSString) GetBindingInfo(NSString) Inherited from NSObject
GetBindingOptionDescriptions(NSString) GetBindingOptionDescriptions(NSString) Inherited from NSObject
GetBindingValueClass(NSString) GetBindingValueClass(NSString) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
HandleBinding(String, SCNBindingHandler) HandleBinding(String, SCNBindingHandler)

Assigns the specified handler that will be run before rendering is handled by the program that is identified by the specified GLSL symbol name.

HandleUnbinding(String, SCNBindingHandler) HandleUnbinding(String, SCNBindingHandler)

Assigns the specified handler that will be run after rendering is handled by the program that is identified by the specified GLSL symbol name.

Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsAnimationPaused(NSString) IsAnimationPaused(NSString)

Returns true if the specified animation is paused.

IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) ObjectDidEndEditing(NSObject) Inherited from NSObject
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PauseAnimation(NSString) PauseAnimation(NSString)

Pauses the specified animation.

PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) 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, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveAllAnimations() RemoveAllAnimations()

Removes all animations from the material.

RemoveAnimation(NSString) RemoveAnimation(NSString)

Removes the specified animation from the material.

RemoveAnimation(NSString, nfloat) RemoveAnimation(NSString, nfloat)

Fades the specified animation out from the material over the specified duration, and removes it.

RemoveAnimationUsingBlendOutDuration(NSString, nfloat) RemoveAnimationUsingBlendOutDuration(NSString, nfloat)
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) 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, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
ResumeAnimation(NSString) ResumeAnimation(NSString)

Resumes the specified animation.

SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetSpeed(nfloat, NSString) SetSpeed(nfloat, NSString)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) 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) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) Unbind(NSString) Inherited from NSObject
Unbind(String) Unbind(String) Inherited from NSObject
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) 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) 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) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor) ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor) ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel) GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem) ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel) AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel) BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel) EndPreviewPanelControl(NSObject, QLPreviewPanel)
AddAnimation(ISCNAnimatable, SCNAnimationPlayer, NSString) AddAnimation(ISCNAnimatable, SCNAnimationPlayer, NSString)
GetAnimationPlayer(ISCNAnimatable, NSString) GetAnimationPlayer(ISCNAnimatable, NSString)
RemoveAnimationUsingBlendOutDuration(ISCNAnimatable, NSString, nfloat) RemoveAnimationUsingBlendOutDuration(ISCNAnimatable, NSString, nfloat)
SetSpeed(ISCNAnimatable, nfloat, NSString) SetSpeed(ISCNAnimatable, nfloat, NSString)

Developers should not use this deprecated method. Developers should use 'SCNAnimationPlayer.Speed' instead.

AddAnimation(ISCNAnimatable, SCNAnimation, String) AddAnimation(ISCNAnimatable, SCNAnimation, String)

Adds the specified animation and associates it with the specified key.

GetProgram(ISCNShadable) GetProgram(ISCNShadable)
GetWeakShaderModifiers(ISCNShadable) GetWeakShaderModifiers(ISCNShadable)
HandleBinding(ISCNShadable, String, SCNBindingHandler) HandleBinding(ISCNShadable, String, SCNBindingHandler)
HandleUnbinding(ISCNShadable, String, SCNBindingHandler) HandleUnbinding(ISCNShadable, String, SCNBindingHandler)
SetProgram(ISCNShadable, SCNProgram) SetProgram(ISCNShadable, SCNProgram)
SetWeakShaderModifiers(ISCNShadable, NSDictionary) SetWeakShaderModifiers(ISCNShadable, NSDictionary)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also