CollisionData Class
Handler for rigid body events.
Syntax
[Sansar.Script.Interface]
public class CollisionData : Sansar.Script.EventData
public class CollisionData : Sansar.Script.EventData
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Members
See Also: Inherited members from Sansar.Script.EventData.
Public Properties
| [read-only]
|
ComponentId | Sansar.Script.ComponentId . The id of the rigid body component. |
| [read-only]
|
EventType | CollisionEventType . The type of collision which occurred. |
| [read-only]
|
HitComponentId | Sansar.Script.ComponentId . The id of the rigid body component or character that was hit. |
| [read-only]
|
HitControlPoint | ControlPointType . The specific control point hit, if any |
| [read-only]
|
HitObject | ObjectPublic . The Sansar.Simulation.ObjectPublic that was hit. |
| [read-only]
|
Phase | CollisionEventPhase . used by trigger events to determine if trigger enter or exit occurred |
Public Methods
|
override
|
ToString () : string
A string representation of this object. |
|
|
override
|
ToString () : string
Generates a string representation of the EventData. (Inherited from Sansar.Script.EventData.) |
|
Member Details
ComponentId Property
The id of the rigid body component.Syntax
[get: Sansar.Script.Interface]
public Sansar.Script.ComponentId ComponentId { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
EventType Property
The type of collision which occurred.Syntax
[get: Sansar.Script.Interface]
public CollisionEventType EventType { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
HitComponentId Property
The id of the rigid body component or character that was hit.Syntax
[get: Sansar.Script.Interface]
public Sansar.Script.ComponentId HitComponentId { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
HitControlPoint Property
The specific control point hit, if anySyntax
[get: Sansar.Script.Interface]
public ControlPointType HitControlPoint { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
HitObject Property
The Sansar.Simulation.ObjectPublic that was hit.Syntax
[get: Sansar.Script.Interface]
public ObjectPublic HitObject { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Phase Property
used by trigger events to determine if trigger enter or exit occurredSyntax
[get: Sansar.Script.Interface]
public CollisionEventPhase Phase { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
ToString Method
A string representation of this object.Syntax
[Sansar.Script.Interface]
public override string ToString ()Returns
A string representation of this object.Remarks
The format of this string may change between releases.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
0 Comments