Click or drag to resize
DigitalRuneRigidBodyShape Property
Gets or sets the shape.

Namespace: DigitalRune.Physics
Assembly: DigitalRune.Physics (in DigitalRune.Physics.dll) Version: 1.10.0.0 (1.10.0.14427)
Syntax
public Shape Shape { get; set; }

Property Value

Type: Shape
The shape. The shape must not be , but it can be of type EmptyShape (see Empty. The default value is a cube with side length 1.

Implements

IGeometricObjectShape
Exceptions
ExceptionCondition
ArgumentNullExceptionvalue is .
Remarks

Changing this property raises the ShapeChanged event.

Important: An IGeometricObject instance registers event handlers for the Changed event of the contained Shape. Therefore, a Shape will have an indirect reference to the IGeometricObject. This is no problem if the geometric object exclusively owns the shape. However, this could lead to problems ("life extension bugs" a.k.a. "memory leaks") when multiple geometric objects share the same shape: One geometric object is no longer used but it cannot be collected by the garbage collector because the shape still holds a reference to the object.

Therefore, when Shapes are shared between multiple IGeometricObjects: Always set the property Shape to Empty when the IGeometricObject is no longer used. Empty is a special immutable shape that never raises any Changed events. Setting Shape to Empty ensures that the internal event handlers are unregistered and the object can be garbage-collected properly.

See Also