SKPhysicsBody Class
Definition
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.
An object that reacts to the physics simulation of the SKScene's PhysicsWorld.
[Foundation.Register("SKPhysicsBody", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 9, ObjCRuntime.PlatformArchitecture.Arch64, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class SKPhysicsBody : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposabletype SKPhysicsBody = class
inherit NSObject
interface INSCoding
interface INativeObject
interface IDisposable
interface INSCopying
interface INSSecureCoding- Inheritance
- Attributes
- Implements
Remarks
The visual appearance of a SKScene is determined by its SKNodes. The physics simulation of a SKScene is determined by the SKPhysicsWorld object of the SKScene's PhysicsWorld property. The physics of that word are applied to those SKNodes that have a non-null PhysicsBody.
The following example demonstrates a simple dynamic system:
var blockSize = new SizeF(20, 20);
var node1 = new SKSpriteNode(UIColor.Red, blockSize) {
Position = new PointF(100, 100),
Name = "Red",
PhysicsBody = SKPhysicsBody.BodyWithRectangleOfSize(blockSize),
};
var node2 = new SKSpriteNode(UIColor.Green, blockSize) {
Position = new PointF(150, 100),
Name = "Green",
PhysicsBody = SKPhysicsBody.BodyWithRectangleOfSize(blockSize)
};
//Pin node1 in position and connect node2 to it with a spring
node1.PhysicsBody.Dynamic = false;
var joint = SKPhysicsJointSpring.Create(node1.PhysicsBody, node2.PhysicsBody, node1.Position, node2.Position);
//Add nodes to scene
scene.AddChild(node1);
scene.AddChild(node2);
//Add the joint to the physics world
scene.PhysicsWorld.AddJoint(joint);
Application developers must add the SKNodes to the scene-graph prior to setting SKPhysicsJoints or Sprite Kit may segfault.
Constructors
| SKPhysicsBody(IntPtr) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. |
| SKPhysicsBody(NSCoder) |
A constructor that initializes the object from the data stored in the unarchiver object. |
| SKPhysicsBody(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
Properties
| AffectedByGravity |
Whether the body is affected by the SKPhysicsWorld's Gravity vector. |
| AllContactedBodies |
Gets an array of all the physics bodies that are in contact with this physics body. |
| AllowsRotation |
Gets or sets a value that tells whether the body can rotate in response to forces and impulses. |
| AngularDamping |
Gets or sets a value between 0.0 and 1.0 (with a default value of 0.1) that determines how quickly rotation is damped. (0.0 corresponds to no damping.) |
| AngularVelocity |
Gets or sets the angular velocity in radians per second. |
| Area |
Gets the area of the physics body, in square meters. |
| CategoryBitMask |
Gets or sets a bitmask that determines the contact and collision behavior of the physics body. |
| Charge |
Gets or sets the electric charge, in Coulombs, for the physics body. |
| Class | (Inherited from NSObject) |
| ClassHandle |
The handle for this class. |
| CollisionBitMask |
Gets or sets a bitmask that determines the collision behavior of the physics body. |
| ContactTestBitMask |
Gets or sets a bitmask that determines how contacts are determined for the physics body. |
| DebugDescription |
A developer-meaningful description of this object. (Inherited from NSObject) |
| Density |
Gets or sets the density, in kilograms/meter^2, of the physics body. |
| Description |
Description of the object, the Objective-C version of ToString. (Inherited from NSObject) |
| Dynamic |
Gets or sets a value the tells whether the physics body is affected by forces and impulses in the simulation. |
| FieldBitMask |
Gets or sets a bitmask that controls which kinds of fields can affect the physics body. |
| Friction |
Gets or sets a value between 0.0 and 1.0, with a default of 0.2, that describes the surface roughness of the physics body. |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| IsDirectBinding | (Inherited from NSObject) |
| IsProxy | (Inherited from NSObject) |
| Joints |
Gets an array that contains the joints that are connected to the physics body. |
| LinearDamping |
Gets or sets a value between 0.0 and 1.0, with a default of 0.1, that determines how quickly that the linear motion of the physics body is damped. |
| Mass |
Gets or sets the mass of the physics body. (Updates the density when set.) |
| Node |
Gets the node, if any, that the physics body is connected to. |
| Pinned |
Gets or sets a value that tells whether the physics body is pinned to its parent node. |
| Resting |
Gets or sets a value that tells whether the body is resting on another body in the simulation, and thus does not participate in the simulation. |
| Restitution |
Gets or sets the proportion of energy, between 0.0 and 1.0, that the physics body loses when it bounces off of another physics body. The default is 0.2. |
| RetainCount |
Returns the current Objective-C retain count for the object. (Inherited from NSObject) |
| Self | (Inherited from NSObject) |
| Superclass | (Inherited from NSObject) |
| SuperHandle |
Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject) |
| UsesPreciseCollisionDetection |
Gets or sets a value that controls whether a precise detection algorithm, suitable for reducing false misses between small and fast physics bodies, is used.. |
| Velocity |
Gets or sets the magnitude and direction of the motion of the physics body. |
| Zone | (Inherited from NSObject) |
Methods
| 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) |
| ApplyAngularImpulse(nfloat) |
Applies the specified angular impulse, in Newton-seconds, to the physics body. |
| ApplyForce(CGVector) |
Applies a force, in Newtons, through the center of mass of the physics body for one time step. |
| ApplyForce(CGVector, CGPoint) |
Applies a force, in Newtons, at the specified point for one time step. |
| ApplyImpulse(CGVector) |
Applies an impulse, in Newton-seconds, through the center of mass of the physics body. |
| ApplyImpulse(CGVector, CGPoint) |
Applies an impulse, in Newton-seconds, to the physics body through the specified point. |
| ApplyTorque(nfloat) |
Applies a torque, in Newton-meters, to the physics body for one time step. |
| 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(SKTexture, CGSize) |
Creates a new physics body with the specified texture and size. |
| Create(SKTexture, Single, CGSize) |
Creates a new physics body with the specified values. |
| CreateBodyFromPath(CGPath) |
Creates a new physics body from the specified path. |
| CreateCircularBody(nfloat) |
Creates a new circular physics body with the specified radius. |
| CreateCircularBody(nfloat, CGPoint) |
Creates a new circular physics body with the specified radius and center. |
| CreateEdge(CGPoint, CGPoint) |
Creates an edge from one point to another. |
| CreateEdgeChain(CGPath) |
Creates an edge chain from the specified path. |
| CreateEdgeLoop(CGPath) |
Creates a closed edge loop from the specified path, closing the path if necessary. |
| CreateEdgeLoop(CGRect) |
Creates a closed edge loop from the specified rectangle. |
| CreateRectangularBody(CGSize) |
Creates a rectangular physics body from the specified rectangle. |
| CreateRectangularBody(CGSize, CGPoint) |
Creates a rectangular physics body from the specified rectangle and center. |
| 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 SKPhysicsBody 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 |
| Equals(NSObject) | (Inherited from NSObject) |
| Equals(Object) | (Inherited from NSObject) |
| ExposedBindings() | (Inherited from NSObject) |
| FromBodies(SKPhysicsBody[]) |
Creates a new physics body from the union of the specified list of physics bodies. |
| 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) | (Inherited from NSObject) |
| InitializeHandle(IntPtr, String) | (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) |
| 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) |
| 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 |
| 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) |
| 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) |
| RespondsToSelector(Selector) |
Whether this object recognizes the specified selector. (Inherited from NSObject) |
| SetNativeField(String, NSObject) |
Obsolete.
(Inherited from NSObject)
|
| SetNilValueForKey(NSString) |
Sets the value of the specified key to null. (Inherited from NSObject) |
| 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) |