SCNNode Class

Definition

A node in the scene graph.

[Foundation.Register("SCNNode", 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 SCNNode : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposable, SceneKit.ISCNActionable, SceneKit.ISCNAnimatable, SceneKit.ISCNBoundingVolume, System.Collections.Generic.IEnumerable<SceneKit.SCNNode>
type SCNNode = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSSecureCoding
    interface ISCNActionable
    interface ISCNAnimatable
    interface ISCNBoundingVolume
    interface IEnumerable
    interface seq<SCNNode>
Inheritance
SCNNode
Derived
Attributes
Implements

Constructors

SCNNode()

Default constructor, initializes a new instance of this class.

SCNNode(IntPtr)

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

SCNNode(NSCoder)

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

SCNNode(NSObjectFlag)

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

Properties

ActionKeys

Gets the list of keys for which there are actions.

AudioPlayers

Gets a list of the currently attached audio players.

Camera

Gets or sets the camera on the node.

CanBecomeFocused
CastsShadow

Gets or sets a Boolean value that controls whether the node contents are rendered into shadow maps.

CategoryBitMask

Gets or sets the category bit mask.

ChildNodes

Gets the children of the node.

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

Constraints

Gets or sets the list of constraints on the node.

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)
EulerAngles

Gets or sets the Euler angles that define the node's orientation.

Filters

Gets or sets the Core Image filters to apply to the node's rendered contents.

FocusBehavior
FocusItemContainer

Gets the container that manages focus information for child focus items.

Frame

Gets the frame of the node, in the coordinate system of the parent focus environment.

Geometry

Gets the geometry for the node.

Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
Hidden

Gets or sets a Boolean value that hides or shows the node's contents.

IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
Light

Gets or sets an attached light.

LocalFront
LocalRight
LocalUp
Morpher

Gets or sets the object that blends the node's geometry.

MovabilityHint

Gets or sets a value that controls how the node's contents visually respond to motion effects.

Name

Gets or sets a descriptive name for the node

Opacity

Gets or sets the opacity of the node's contents.

Orientation

Gets or sets the orientation of the node.

ParentFocusEnvironment

Gets the parent focus environment.

ParentNode

Gets the parent node.

ParticleSystems

Gets an array that contains the particle systems that are attached to the node.

Paused

Gets or sets a Boolean value that controls whether animations on the node's contents are paused.

PhysicsBody

Gets or sets the node's physics body.

PhysicsField

Gets or sets the node's physics field.

Pivot

Gets or sets the point about which the node pivots, rotates, and scales.

Position

Gets or sets the node's position in the scene.

PreferredFocusedView
PreferredFocusEnvironments
PresentationNode

Gets a representation of the node as it appears on the screen.

RendererDelegate

Gets or sets the rendering delegate for the node.

RenderingOrder

Gets or sets the rendering order for the node.

RetainCount

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

(Inherited from NSObject)
Rotation

Gets or sets the node's rotation.

Scale

Gets or sets the scale factor for the node.

Self (Inherited from NSObject)
Skinner

Gets or sets the skinner for skeletal animations.

Superclass (Inherited from NSObject)
SuperHandle

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

(Inherited from NSObject)
Transform

Gets or sets the parent-relative transform of the node.

WeakRendererDelegate

Gets or sets a weak reference to the renderer delegate.

WorldFront
WorldOrientation
WorldPosition
WorldRight
WorldTransform

Gets or sets the world-relative transform for the node.

WorldUp
Zone (Inherited from NSObject)

Methods

Add(SCNNode)

Adds node as a child of this SCNNode.

AddAnimation(CAAnimation, NSString)

Adds the animation to this SCNNode and associates it with the key.

AddAnimation(CAAnimation, String)

Adds the animation to this SCNNode and associates it with the key.

AddAnimation(SCNAnimationPlayer, NSString)
AddAudioPlayer(SCNAudioPlayer)

Adds the player and starts playback.

AddChildNode(SCNNode)

Adds the specified node as a child to this SCNNode.

AddNodes(SCNNode[])

Adds the specified nodes as children of this SCNNode.

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)
AddParticleSystem(SCNParticleSystem)

Adds the specified particle system system to this SCNNode.

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) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
Clone()

Creates and returns a recursive copy of the node and its children.

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)
ConvertPositionFromNode(SCNVector3, SCNNode)

Converts position, provided in the coordinate space of node into this node's coordinate space.

ConvertPositionToNode(SCNVector3, SCNNode)

Converts position, provided in this node's coordinate space, into the coordinate space of node.

ConvertTransformFromNode(SCNMatrix4, SCNNode)

Converts transform, provided in the coordinate space of node into this node's coordinate space.

ConvertTransformToNode(SCNMatrix4, SCNNode)

Converts transform, provided in this node's coordinate space, into the coordinate space of node.

ConvertVectorFromNode(SCNVector3, SCNNode)
ConvertVectorToNode(SCNVector3, SCNNode)
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 empty Scene Kit node.

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)
DidHintFocusMovement(UIFocusMovementHint)

Called when the user's finger moves on the device or pad, to alert the Node that a focus change may occur.

DidUpdateFocus(UIFocusUpdateContext, UIFocusAnimationCoordinator)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the SCNNode object.

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

EnumerateChildNodes(SCNNodeHandler)

Runs the provided handler on each of the node's children.

EnumerateChildNodes(SCNNodePredicate)

Deprecated. Do not use.

EnumerateHierarchy(SCNNodeHandler)

Recursively runs the provided handler on this node and on each of this node's descendants.

Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
FindChildNode(String, Boolean)

Searches for a child with the specified name.

FindNodes(SCNNodePredicate)

Returns an array of all descendant nodes that match the provided predicate.

FlattenedClone()

Creates and returns a flattened copy of the node and its all of its descendants.

FromGeometry(SCNGeometry)

Creates a node from the provided geometry.

FromModelObject(MDLObject)

Creates a node from the provided Model IO object.

GetAction(String)

Returns the action that is identified by the supplied key.

GetAnimation(NSString)

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

GetAnimation(String)

Returns the animation that is identified by the supplied key.

GetAnimationKeys()

Returns an array that contains all of the animations that are attached to the node.

GetAnimationPlayer(NSString)
GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetBoundingBox(SCNVector3, SCNVector3)

Stores the vectors that define the node's bounding box in min and max, or allows the developer to set them.

GetBoundingSphere(SCNVector3, nfloat)

Stores the vectors that define the node's bounding sphere in center and radius, or allows the developer to set them.

GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetEnumerator()

Gets an enumerator for iterating over the node's descendants.

GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
HasActions()

Gets a Boolean value that tells whether the node is running any actions.

HitTest(SCNVector3, SCNVector3, NSDictionary)

Returns an array of hit test results for descendant nodes that intersect with a line between pointA and pointB.

HitTest(SCNVector3, SCNVector3, SCNHitTestOptions)

Returns an array of hit test results for descendant nodes that intersect with a line between pointA and pointB.

Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
InsertChildNode(SCNNode, nint)

Inserts the provided child node at the specified index.

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 a Boolean value that tells whether the animation that is identified by the specified key is paused.

IsAnimationPaused(String)

Returns a Boolean value that tells whether the animation that is identified by the specified key is paused.

IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
LocalRotate(SCNQuaternion)
LocalTranslate(SCNVector3)
Look(SCNVector3)
Look(SCNVector3, SCNVector3, SCNVector3)
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 animation that is identified by the provided key.

PauseAnimation(String)

Pauses the animation that is identified by the provided key.

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

Removes the action that is identified by the provided key

RemoveAllActions()

Removes all actions from the node.

RemoveAllAnimations()

Removes all animations from the node.

RemoveAllAudioPlayers()

emoves all audio players from the node.

RemoveAllParticleSystems()

emoves all particle systems from the node.

RemoveAnimation(NSString)

Removes the animation that is identified by the provided key.

RemoveAnimation(NSString, nfloat)

Removes the animation that is identified by the provided key, fading it out over duration seconds.

RemoveAnimation(String)

Removes the animation that is identified by the provided key.

RemoveAnimation(String, nfloat)

Removes the animation that is identified by the provided key, fading it out over duration seconds.

RemoveAnimationUsingBlendOutDuration(NSString, nfloat)
RemoveAudioPlayer(SCNAudioPlayer)

Removes the specified audio player from the node.

RemoveFromParentNode()

Removes this node from the parent node.

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)

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

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

(Inherited from NSObject)
RemoveParticleSystem(SCNParticleSystem)

Removes the specified particle system from the node.

ReplaceChildNode(SCNNode, SCNNode)

Replaces the specified child node with the provided child2 node.

RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
ResumeAnimation(NSString)

Resumes the animation that is identified by the provided key.

ResumeAnimation(String)

Resumes the animation that is identified by the provided key.

Rotate(SCNQuaternion, SCNVector3)
RunAction(SCNAction)

Adds the provided action to the node.

RunAction(SCNAction, Action)

Adds the provided action to the node and runs block after the operation completes.

RunAction(SCNAction, String)

Adds the provided action to the node and indexes it with the provided key.

RunAction(SCNAction, String, Action)

Adds the provided action to the node, indexes it with the provided key, and runs the provide block after the operation completes.

SetBoundingBox(SCNVector3, SCNVector3)

Sets the bounding box of the node.

SetNativeField(String, NSObject) (Inherited from NSObject)
SetNeedsFocusUpdate()
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)
ShouldUpdateFocus(UIFocusUpdateContext)
ToString()

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

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String) (Inherited from NSObject)
UpdateFocusIfNeeded()
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)

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Gets an enumerator for the node's children.

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
GetEntity(SCNNode)
SetEntity(SCNNode, GKEntity)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetActionKeys(ISCNActionable)
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

See also