Marks an entity as something that perceives touch. Sources collision events from its Meshes. The detector defers subscribing to those mesh events until it has at least one subscriber, and tears the subscriptions down when the last subscriber cancels.
Verse using statement |
using { /Verse.org/Perception } |
Inheritance Hierarchy
This class is derived from component.
| Name | Description |
|---|---|
component |
Base class for authoring logic and data in the SceneGraph. Using components you can author re-usable building blocks of logic and data which can then be added to entities in the scene. Components are a very low level building block which can be used in many ways. For example:
As components are generic there is no specific way that they must be used. It is up to the needs of your experience if you use one big game component or if you break up logic into many small components. Classes deriving from component must also specify Only one instance of a component from each subclass group can be added to an entity at a time. For example, given this group of components, only one light_component can exist on a single entity. To create multiple lights you should use multiple entities. light_component := class ============================================================================== Component Lifetime Components move through a series of lifetime functions as they are added to entities, added to the scene, and begin running in the simulation. Components should override these methods to perform setup and run their simulation. As a component shuts down it will then move through shutdown version of these
functions, giving users the opportunity to clean up any retained state on the
component before it is disposed
.
Lifetime Methods:
OnAddedToScene
OnBeginSimulation -> OnSimulate |
Members
This class has both data members and functions.
Data
| Data Member Name | Type | Description |
|---|---|---|
Entity |
entity |
The parent entity of this component.
|
Meshes |
?[]mesh_component |
Mesh components whose collision events feed this detector. Multiple meshes suit entities like vehicles with many collision-participating meshes but one touch listener. Left empty, the detector uses a mesh_component on its own entity at simulation start. |
TickEvents |
?tick_events |
Set callbacks to |
Functions
| Function Name | Description |
|---|---|
AddMeshComponents |
Add mesh components to the detector's collision-event sources. If the detector currently has active subscribers, the collision listeners are re-wired immediately to include the new meshes. |
GetCurrentTouchData |
Return the latest touch_data cached for Emitter. Succeeds while this detector has an open contact with it, fails otherwise. Refreshed on every continuing-collide signal. |
IsInScene |
Succeeds if the component is currently in the scene.
|
IsSimulating |
Succeeds if the component is currently simulating.
|
OnAddedToScene |
Called when the component is added to the scene by parenting it under the simulation entity or another entity already in the scene.
|
OnBeginSimulation |
|
OnBeginSimulation |
Called when the component begins simulating within the scene.
|
OnEndSimulation |
|
OnEndSimulation |
Called when the component ends simulation within the scene.
|
OnReceive |
Respond to a scene event. Return true to consume the event and halt propagation to the next entity. |
OnRemovingFromScene |
Called when the component is about to be removed from the scene.
|
OnSimulate |
|
OnSimulate |
Called when the component begins simulating within the scene.
|
RemoveFromEntity |
Removes the component from the entity.
|
RemoveMeshComponents |
Remove mesh components from the detector's collision-event sources. If the detector currently has active subscribers, the collision listeners are re-wired to drop the removed meshes. |
SendDown |
Send a scene event to this component, invoking OnReceive. Returns true if any participant consumed the event. |
Subscribe |
Subscribe Receiver to touch events from this detector. Filter runs against each event; deciding delivers to Receiver.OnReceive (via SendDown). Cancel the returned cancelable to unsubscribe. On the first subscriber the detector wires up its mesh collision listeners. |