SCNGeometry SCNGeometry Class

Definition

Base class for SceneKit geometry objects

[Foundation.Register("SCNGeometry", 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 SCNGeometry : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposable, SceneKit.ISCNAnimatable, SceneKit.ISCNBoundingVolume, SceneKit.ISCNShadable
type SCNGeometry = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSSecureCoding
    interface ISCNAnimatable
    interface ISCNBoundingVolume
    interface ISCNShadable
Inheritance
SCNGeometrySCNGeometry
Derived
Attributes
Implements

Remarks

All geometry in SceneKit is described by subclasses of SCNGeometry:

SCNCapsule A pill-shaped capsule with adjustable end caps
SCNCone A cone whose top can be truncated
T:SceneKit.SCNBox A rectangular box.
SCNCylinder A cylinder.
SCNFloor An infinite plane with the ability to reflect the geometry above it.
SCNPlane A one-sided rectangle.
SCNPyramid A tetrahedron.
SCNShape A 2D shape that has been extruded into the 3rd dimension.
SCNSphere A ball.
SCNText Extruded text.
SCNTorus A donut shape.
SCNTube An uncapped cylinder.

Subclasses are typically instantiated with a static Create factory method rather than a constructor.

In addition, SceneKit can load entire scenes from .DAE files with the M:SceneKit.SCNScene.FromFile* method.

Developers can create geometry from a ModelIO mesh using FromMesh(MDLMesh).

Finally, developers can create custom geometry using the M:SceneKit.SCNGeometry.Create(SceneKit.SCNGeometrySource[], SceneKit.SCNGeometryElement[]* method with arrays of appropriate SCNGeometrySource and SCNGeometryElement objects. The following shows the creation of a custom pyramid:


//Lower-left
var a = new SCNVector3(-1, -1, 0);
//Upper-right
var b = new SCNVector3(1, 1, 0);

var halfX = (c.X + a.X) / 2; var halfY = (c.Y + a.Y) / 2; var halfZ = (c.Z + a.Z) / 2;

var b = new SCNVector3(a.X, c.Y, halfZ); var d = new SCNVector3(c.X, a.Y, halfZ); //Elevate the midpoint so that it's clearly a pyramid var midPoint = new SCNVector3(halfX, halfY, halfZ + 1.0);

//The vertices of the geometry var locs = new [] { a, b, c, d, midPoint }; var locSource = SCNGeometrySource.FromVertices(locs);

//Note that this relies on the ordering of locs above //and it defines triangles (could be triangle strips, etc.) var indices = new [] { //Triangles are defined counter-clockwise! 4, 1, 0, 1, 4, 2, 2, 4, 3, 3, 4, 0 };

var idxArray = new byte[indices.Length][]; for(int i = 0; i < idxArray.Length; i++) { idxArray[i] = BitConverter.GetBytes(indices[i]); } var idxData = NSData.FromArray(idxArray.SelectMany(id => id).ToArray());

//Note that this relies on indices defining triangles var element = SCNGeometryElement.FromData(idxData, SCNGeometryPrimitiveType.Triangles, indices.Length / 3, sizeof(int));

//Normals are relative to geometry var normals = new [] { new SCNVector3(0, 0, 1), new SCNVector3(0, 0, 1), new SCNVector3(0, 0, 1), new SCNVector3(0, 0, 1), new SCNVector3(0, 0, 1), };; var normSource = SCNGeometrySource.FromNormals(normals);

//These texture coords will cause the texture to wrap var txCoords = new [] { new CGPoint(-1, -1), new CGPoint(-1, 1), new CGPoint(1, 1), new CGPoint(1, -1) };

var txCoordsSource = SCNGeometrySource.FromTextureCoordinates(txCoords);

var geometry = SCNGeometry.Create(new [] { locSource, normSource, txCoordsSource }, new [] { element });

Constructors

SCNGeometry(IntPtr) SCNGeometry(IntPtr)

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

SCNGeometry(NSCoder) SCNGeometry(NSCoder)

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

SCNGeometry(NSObjectFlag) SCNGeometry(NSObjectFlag)

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

Properties

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

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

Gets or sets a line whose points specify an array of vertex indices that specify edges that should remain sharp over the operation of subdivision.

EdgeCreasesSource EdgeCreasesSource

Gets or sets an array of edge crease values, from 0.0 (smoothed) to 10.0 (sharp), that specify the relative sharpness of each corresponding element in EdgeCreasesElement.

FirstMaterial FirstMaterial

Gets or sets the first material in the geometry element's Materials property.

GeometryElementCount GeometryElementCount

Gets the number of elements in the geometry.

GeometryElements GeometryElements

The array of SCNGeometryElement objects contributing to the geometry.

GeometrySources GeometrySources

The array of SCNGeometrySource objects contributing to the geometry.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
LevelsOfDetail LevelsOfDetail

Gets or sets detail levels for viewing at various distances.

Materials Materials

Gets or sets the list of materials that control the appearance of their corresponding entries in the list of elements that belong to the geometry.

Name Name

Gets or sets the name of the geometry.

Program Program

Gets the custom shader program, if any.

RetainCount RetainCount

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

(Inherited from NSObject)
Self Self Inherited from NSObject
ShaderModifiers ShaderModifiers

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

SubdivisionLevel SubdivisionLevel

Gets or sets the number of times that each face of the geometry is subdivided for smoothing.

Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

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

(Inherited from NSObject)
Tessellator Tessellator
WantsAdaptiveSubdivision WantsAdaptiveSubdivision
WeakShaderModifiers WeakShaderModifiers

Gets or sets a weak reference to the shader modifiers.

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 geometry element.

Create(SCNGeometrySource[], SCNGeometryElement[]) Create(SCNGeometrySource[], SCNGeometryElement[])

Creates a new geometry object from the specified arrays of sources and elements.

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
FromMesh(MDLMesh) FromMesh(MDLMesh)

Creates geometry from a MDLMesh.

FromSources(SCNGeometrySource[], SCNGeometryElement[]) FromSources(SCNGeometrySource[], SCNGeometryElement[])

M:SceneKit.SCNGeometry.Create(SCNGeometrySource[], SCNGeometryElement[])

GetAnimation(NSString) GetAnimation(NSString)

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

GetAnimationKeys() GetAnimationKeys()

Gets the list of keys for the animations on this geometry.

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

Returns true, and fills min and max with the corners of the bounding box, if the geometry object has volume. Otherwise, returns false and the parameters are undefined.

GetBoundingSphere(SCNVector3, nfloat) GetBoundingSphere(SCNVector3, nfloat)

Returns true, and fills center and radius with the bounding sphere data, if the geometry object has volume. Otherwise, returns false and the parameters are undefined.

GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetGeometryElement(nint) GetGeometryElement(nint)

Gets the element at elementIndex in the geometry's list of elements.

GetGeometrySourcesForSemantic(String) GetGeometrySourcesForSemantic(String)

Returns an array of all the geometry sources that have the specified semantic.

GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMaterial(String) GetMaterial(String)

Returns the first material that is attached to the geometry and has the specified name.

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
InsertMaterial(SCNMaterial, nint) InsertMaterial(SCNMaterial, nint)

Inserts the specified material at the specified index.

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 geometry.

RemoveAnimation(NSString) RemoveAnimation(NSString)

Removes the specified animation from the geometry.

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

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

RemoveAnimationUsingBlendOutDuration(NSString, nfloat) RemoveAnimationUsingBlendOutDuration(NSString, nfloat)
RemoveMaterial(nint) RemoveMaterial(nint)

Removes the material at the specified index.

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)
ReplaceMaterial(nint, SCNMaterial) ReplaceMaterial(nint, SCNMaterial)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

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

Resumes the specified animation.

SetBoundingBox(SCNVector3, SCNVector3) SetBoundingBox(SCNVector3, SCNVector3)

Overrides the default bounding box for the geometry.

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