Click or drag to resize

RigidBody2D Class

2D rigid physical body.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2022.1.1.0 (2022.1.1.0)
Syntax
C#
public class RigidBody2D : PhysicalBody2D

The RigidBody2D type exposes the following members.

Constructors
  NameDescription
Public methodRigidBody2D
Initializes a new instance of the RigidBody2D class
Top
Properties
  NameDescription
Public propertyActive
Gets the sleep state of the body. A sleeping body has very low CPU cost.
Public propertyAllowSleep
Allows sleep the body.
Public propertyAngularDamping
The angular reduction of velocity over time.
Public propertyAngularVelocity
The initial angular velocity of the body.
Public propertyAnyData
The user data of the component.
(Inherited from Component.)
Public propertyBaseType
Gets the base type of the object.
(Inherited from Component.)
Public propertyCanBeSelected
Whether the object is selectable in the scene view.
(Inherited from ObjectInSpace.)
Public propertyCanBeSelectedInHierarchy (Inherited from ObjectInSpace.)
Public propertyCCD
Gets or sets a value indicating whether this body should be included in the CCD solver.
Public propertyCloneSupport
Whether the object supports cloning.
(Inherited from Component.)
Public propertyComponents
Gets the collection of the child components.
(Inherited from Component.)
Public propertyContactsDisplay
Whether to display collected collision contacts data.
Public propertyCreatedByBaseType
Whether the object is created using a base type.
(Inherited from Component.)
Public propertyDisplayInEditor
Whether to show the object in the editor.
(Inherited from Component.)
Public propertyDisposed
Whether the object is disposed.
(Inherited from Component.)
Public propertyEditorDocumentConfiguration
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component.)
Public propertyEditorReadOnly
Whether the object is read only in the editor.
(Inherited from Component.)
Public propertyEditorReadOnlyInHierarchy
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component.)
Public propertyEnabled
Whether the component is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public propertyEnabledInHierarchy
Determines whether the object is attached to a hierarchy of the components and enabled. The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyEnabledInHierarchyAndIsNotResource
Determines when the object is attached to a hierarchy of the components, is enabled and the object if not part of a resource (it is usual object instance). The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyEnabledSelectionByCursor (Inherited from ObjectInSpace.)
Public propertyEnableGravity
Whether the rigid body is affected by the gravity.
Public propertyFixedRotation
Whether the body to have fixed rotation.
Public propertyHierarchyController
Gets the object hierarchy control controller.
(Inherited from Component.)
Public propertyInertia
Gets or sets the rotational inertia of the body about the local origin.
Public propertyLinearDamping
The linear reduction of velocity over time.
Public propertyLinearVelocity
The initial linear velocity of the body.
Public propertyLocalCenter
Gets or sets the local position of the center of mass.
Public propertyMass
The mass of the rigid body.
Public propertyMotionType
The type of motion used.
Public propertyName
The name of the component.
(Inherited from Component.)
Public propertyParent
Gets the parent object.
(Inherited from Component.)
Public propertyParentRoot
Gets the parent root object.
(Inherited from Component.)
Public propertyParentScene (Inherited from ObjectInSpace.)
Public propertyPhysics2DBody (Overrides PhysicalBody2DPhysics2DBody.)
Public propertyRemainingLifetime
The lifetime of the component during the simulation.
(Inherited from ObjectInSpace.)
Public propertyRemoveFromParentQueued
Whether the object is placed in the detach queue from the parent.
(Inherited from Component.)
Public propertySaveSupport
Whether the object supports saving to a file.
(Inherited from Component.)
Public propertyScreenLabel
Sets the display of the on-screen label of the object in the scene editor.
(Inherited from Component.)
Public propertySpaceBounds (Inherited from ObjectInSpace.)
Public propertySpaceBoundsOverride (Inherited from ObjectInSpace.)
Public propertyTransform
The position, rotation and scale of the object.
(Inherited from ObjectInSpace.)
Public propertyTransformV
Simplier form of Transform.Value.
(Inherited from ObjectInSpace.)
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
(Inherited from Component.)
Public propertyVisible
Whether the object is visible in the scene.
(Inherited from ObjectInSpace.)
Public propertyVisibleInHierarchy (Inherited from ObjectInSpace.)
Top
Methods
  NameDescription
Public methodAddComponent
Adds a component as a child.
(Inherited from Component.)
Public methodApplyAngularImpulse
Apply an angular impulse.
Public methodApplyForce(Vector2)
Applies a force at the center of mass.
Public methodApplyForce(Vector2, Vector2)
Apply a force at a world point. If the force is not applied at the center of mass, it will generate a torque and affect the angular velocity. This wakes up the body.
Public methodApplyLinearImpulse(Vector2)
Apply an impulse at a point. This immediately modifies the velocity. This wakes up the body.
Public methodApplyLinearImpulse(Vector2, Vector2)
Apply an impulse at a point. This immediately modifies the velocity. It also modifies the angular velocity if the point of application is not at the center of mass. This wakes up the body.
Public methodApplyTorque
Apply a torque. This affects the angular velocity without affecting the linear velocity of the center of mass. This wakes up the body.
Public methodCheckSelectionByRay (Inherited from ObjectInSpace.)
Public methodClone
Creates a copy of the object.
(Inherited from Component.)
Public methodCreateComponent(Type, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponentT(Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodDispose
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindParent(Type)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParent(MetadataTypeInfo)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParentT
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(Type)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(MetadataTypeInfo)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParentT
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodGetAllParents
Gets all parents of the component.
(Inherited from Component.)
Public methodGetComponent(String, Boolean)
Finds a child component by name.
(Inherited from Component.)
Public methodGetComponent(Type, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponent(MetadataTypeInfo, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentT(Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentByNameWithIndex
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component.)
Public methodGetComponentByPath
Finds a child component by path.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Type, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPathFromParent
Returns the path to the object from the parent.
(Inherited from Component.)
Public methodGetPathFromRoot
Returns the object's access path from the root object.
(Inherited from Component.)
Public methodGetProvidedType
Returns a type when the object is used as a type.
(Inherited from Component.)
Public methodGetScreenLabelInfo (Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMethodInvoking (Inherited from Component.)
Public methodLookAt(ObjectInSpace) (Inherited from ObjectInSpace.)
Public methodLookAt(Vector3) (Inherited from ObjectInSpace.)
Public methodLookAt(ObjectInSpace, Vector3) (Inherited from ObjectInSpace.)
Public methodLookAt(Vector3, Vector3) (Inherited from ObjectInSpace.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMetadataGetMemberBySignature
Returns the object metadata member by name.
(Inherited from Component.)
Public methodMetadataGetMembers
Returns the object metadata members.
(Inherited from Component.)
Public methodMethodInvoke
Calls a method by name.
(Inherited from Component.)
Public methodMethodInvokeCancel (Inherited from Component.)
Public methodMethodInvokeCancelAll (Inherited from Component.)
Public methodNewObjectSetDefaultConfiguration
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component.)
Public methodNewObjectSetDefaultConfigurationUpdate
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component.)
Protected methodOnAddedToParent
Called when a component is added to the parent.
(Inherited from Component.)
Protected methodOnCheckSelectionByRay (Overrides ObjectInSpaceOnCheckSelectionByRay(ObjectInSpaceCheckSelectionByRayContext).)
Protected methodOnClone
Called when the object is cloned.
(Inherited from Component.)
Protected methodOnComponentAdded
Called when a child component is added.
(Inherited from Component.)
Protected methodOnComponentRemoved
Called when a child component is removed.
(Inherited from Component.)
Protected methodOnDisabled
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDisabledInSimulation
Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDispose
Called when the object is disposed.
(Inherited from Component.)
Protected methodOnEditorGetTextInfoCenterBottomCorner (Inherited from Component.)
Protected methodOnEnabled
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnEnabledChanged
Called when value of Enabled property is changed.
(Inherited from Component.)
Protected methodOnEnabledInHierarchyChanged (Overrides ObjectInSpaceOnEnabledInHierarchyChanged.)
Protected methodOnEnabledInSimulation
Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnEnabledSelectionByCursor (Overrides ObjectInSpaceOnEnabledSelectionByCursor.)
Protected methodOnGetRenderSceneData (Overrides ObjectInSpaceOnGetRenderSceneData(ViewportRenderingContext, GetRenderSceneDataMode, SceneGetObjectsInSpaceItem).)
Protected methodOnLifetimeEnd (Inherited from ObjectInSpace.)
Protected methodOnLoad
Called during object loading.
(Inherited from Component.)
Protected methodOnMetadataGetMemberBySignature
Called when the object metadata member is received by name.
(Inherited from Component.)
Protected methodOnMetadataGetMembers
Called upon receipt of the object's metadata members.
(Inherited from Component.)
Protected methodOnMetadataGetMembersFilter (Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean).)
Protected methodOnOcclusionCullingDataContains (Inherited from ObjectInSpace.)
Protected methodOnOcclusionCullingDataGet (Inherited from ObjectInSpace.)
Protected methodOnPreloadResources
Called when preloading the resources used by the object.
(Inherited from Component.)
Protected methodOnRemovedFromParent
Called when a component is removed from the parent.
(Inherited from Component.)
Protected methodOnSave
Called during object saving.
(Inherited from Component.)
Protected methodOnSimulationStep (Inherited from ObjectInSpace.)
Protected methodOnSpaceBoundsChanged (Inherited from ObjectInSpace.)
Protected methodOnSpaceBoundsUpdate (Overrides ObjectInSpaceOnSpaceBoundsUpdate(SpaceBounds).)
Protected methodOnSpaceBoundsUpdateIncludeChildren (Inherited from ObjectInSpace.)
Protected methodOnTransformChanged (Overrides ObjectInSpaceOnTransformChanged.)
Protected methodOnTransformUpdating (Inherited from ObjectInSpace.)
Protected methodOnUpdate
Called during the update process of all objects.
(Inherited from Component.)
Public methodPreloadResources
Preload resources used by the object.
(Inherited from Component.)
Public methodPropertyGet(String, Object, Boolean)
Gets the value of a property by name.
(Inherited from Component.)
Public methodPropertySet
Sets the value of a property by name.
(Inherited from Component.)
Public methodRecreateBody
Public methodRemoveAllComponents
Removes all child components.
(Inherited from Component.)
Public methodRemoveComponent
Removes a child component.
(Inherited from Component.)
Public methodRemoveFromParent
Detaches the object from its parent.
(Inherited from Component.)
Public methodRender (Overrides PhysicalBody2DRender(ViewportRenderingContext, Int32).)
Public methodSetPosition(Vector3) (Inherited from ObjectInSpace.)
Public methodSetPosition(Double, Double, Double) (Inherited from ObjectInSpace.)
Public methodSetRotation(Angles) (Inherited from ObjectInSpace.)
Public methodSetRotation(Quaternion) (Inherited from ObjectInSpace.)
Public methodSetRotation(Double, Double, Double) (Inherited from ObjectInSpace.)
Public methodSetScale(Double) (Inherited from ObjectInSpace.)
Public methodSetScale(Vector3) (Inherited from ObjectInSpace.)
Public methodSetScale(Double, Double, Double) (Inherited from ObjectInSpace.)
Public methodSpaceBoundsUpdate (Inherited from ObjectInSpace.)
Public methodToString
Returns the name and type of the object as a string.
(Inherited from Component.)
Public methodTypeSettingsIsPublic
Checks whether the object provided as a type is public.
(Inherited from Component.)
Public methodTypeSettingsIsPublicMember
Checks whether the member is set up as public.
(Inherited from Component.)
Public methodUpdateDataFromPhysicsEngine (Overrides PhysicalBody2DUpdateDataFromPhysicsEngine.)
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
(Inherited from Component.)
Public eventAllowSleepChanged
Occurs when the AllowSleep property value changes.
Public eventAngularDampingChanged
Occurs when the AngularDamping property value changes.
Public eventAngularVelocityChanged
Occurs when the AngularVelocity property value changes.
Public eventCanBeSelectedChanged
Occurs when the CanBeSelected property value changes.
(Inherited from ObjectInSpace.)
Public eventCcdChanged
Occurs when the CCD property value changes.
Public eventCloneEvent
Occurs when object is cloned.
(Inherited from Component.)
Public eventCloneSupportChanged
Occurs after changing value of CloneSupport property.
(Inherited from Component.)
Public eventComponentAdded
Occurs when a child component is added.
(Inherited from Component.)
Public eventComponentRemoved
Occurs when a child component is removed.
(Inherited from Component.)
Public eventComponentsChanged
Occurs when the set of children is changed.
(Inherited from Component.)
Public eventContactsDisplayChanged
Occurs when the ContactsDisplay property value changes.
Public eventDisabledEvent
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisabledInSimulation
Occurs when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisplayInEditorChanged
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component.)
Public eventDisposeEvent
Occurs when the object is disposed.
(Inherited from Component.)
Public eventEnabledChanged
Occurs when the Enabled property value changes.
(Inherited from Component.)
Public eventEnabledEvent
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventEnabledInHierarchyChanged
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component.)
Public eventEnabledInSimulation
Occurs when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventEnableGravityChanged
Occurs when the EnableGravity property value changes.
Public eventFixedRotationChanged
Occurs when the FixedRotation property value changes.
Public eventGetRenderSceneData (Inherited from ObjectInSpace.)
Public eventGetRenderSceneDataBefore (Inherited from ObjectInSpace.)
Public eventInertiaChanged
Occurs when the Inertia property value changes.
Public eventLifetimeEnd (Inherited from ObjectInSpace.)
Public eventLinearDampingChanged
Occurs when the LinearDamping property value changes.
Public eventLinearVelocityChanged
Occurs when the LinearVelocity property value changes.
Public eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventLocalCenterChanged
Occurs when the LocalCenter property value changes.
Public eventMassChanged
Occurs when the Mass property value changes.
Public eventMetadataGetMemberBySignatureEvent
Occurs when the object metadata member is received by name.
(Inherited from Component.)
Public eventMetadataGetMembersEvent
Occurs upon receipt of the object's metadata members.
(Inherited from Component.)
Public eventMetadataGetMembersFilterEvent
Occurs when filtering receive members of the object metadata.
(Inherited from Component.)
Public eventMotionTypeChanged
Occurs when the MotionType property value changes.
Public eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
(Inherited from Component.)
Public eventRemainingLifetimeChanged
Occurs when the RemainingLifetime property value changes.
(Inherited from ObjectInSpace.)
Public eventRemovedFromParent
Occurs when a component is removed from the parent.
(Inherited from Component.)
Public eventSaveEvent
Occurs during object saving.
(Inherited from Component.)
Public eventSaveSupportChanged
Occurs after changing value of SaveSupport property.
(Inherited from Component.)
Public eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
(Inherited from Component.)
Public eventSimulationStep
Occurs during the simulation step.
(Inherited from Component.)
Public eventSpaceBoundsChanged
Occurs when the SpaceBounds property value changes.
(Inherited from ObjectInSpace.)
Public eventSpaceBoundsUpdateEvent (Inherited from ObjectInSpace.)
Public eventSpaceBoundsUpdateIncludeChildrenEvent (Inherited from ObjectInSpace.)
Public eventTransformChanged
Occurs when the Transform property value changes.
(Inherited from ObjectInSpace.)
Public eventTransformUpdatingEvent (Inherited from ObjectInSpace.)
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Public eventVisibleChanged
Occurs when the Visible property value changes.
(Inherited from ObjectInSpace.)
Top
Extension Methods
See Also