Unigine::WorldTrigger Class

Header:	#include <UnigineWorlds.h>
Inherits:	Node

World triggers fire callbacks when any nodes (colliders or not) get inside or outside of them. The trigger can detect a node of any type by its bounding box.

You can either specify a list of nodes, for which the callbacks will be fired, or let the trigger react to all nodes (default behavior). In the latter case, the list of target nodes should be empty. There can be also specified a list of nodes that are skipped by the trigger and are free to pass unnoticed.

The callback function of World Trigger is actually executed only when the next engine function is called: that is, before updatePhysics() (in the current frame) or before update() (in the next frame) — whatever comes first.

Notice

If you have moved some nodes and want to get callbacks based on changed positions in the same frame, you need to call engine.world.updateSpatial() first.

Methods:

Name	Description View: Sort by:
*create*	Constructor.
setEnterCallbackName	Sets a callback function to be fired when nodes are entering the world trigger.
getEnterCallbackName	Returns the name of callback function to be fired on entering the world trigger.
setLeaveCallbackName	Sets a callback function to be fired when nodes are leaving the world trigger.
getLeaveCallbackName	Returns the name of the callback function name to be fired on leaving the world trigger.
getNumNodes	Returns the number of nodes contained in the world trigger.
setSize	Updates the current dimensions of the world trigger.
getSize	Returns the current dimensions of the world trigger.
setTouch	Sets a touch mode for the trigger.
isTouch	Returns a value indicating if a touch mode is enabled for the trigger.
addEnterCallback	Adds a callback function to be fired when a node enters the world trigger.
removeEnterCallback	Removes the specified callback from the list of enter callbacks.
clearEnterCallbacks	Clears all added enter callbacks.
setExcludeNodes	Sets a list of excluded nodes, on which the world trigger will not react.
getExcludeNodes	Returns the current list of excluded nodes, on which the world trigger does not react.
setExcludeTypes	Sets a list of excluded node types, on which the world trigger will not react.
getExcludeTypes	Returns the current list of excluded node types, on which the world trigger does not react.
addLeaveCallback	Adds a callback function to be fired when a node leaves the world trigger.
removeLeaveCallback	Removes the specified callback from the list of leave callbacks.
clearLeaveCallbacks	Clears all added leave callbacks.
getNode	Returns a specified node contained in the world trigger.
getNodes	Gets nodes contained in the trigger.
setTargetNodes	Sets a list of target nodes, which will fire callbacks.
getTargetNodes	Returns the current list of target nodes, which fire callbacks.
setTargetTypes	Sets a list of target node types, which will fire callbacks.
getTargetTypes	Returns the current list of target node types, which fire callbacks.
type	Returns the type of the node.

WorldTrigger Class

Members

static WorldTriggerPtr create ( const Math::vec3 & size ) #

Constructor. Creates a new world trigger with given dimensions.

Arguments

const Math::vec3 & size - Dimensions of the new world trigger. If negative values are provided, 0 will be used instead of them.

void * addEnterCallback ( Unigine::CallbackBase1< Ptr<Node> > * func ) #

Adds a callback function to be fired when a node enters the world trigger. The callback function must receive a Node as its first argument. In addition, it can also take 2 arguments of any type.

Source code (C++)

// implement the enter callback
void AppWorldLogic::enter_callback(NodePtr node){
	Log::message("\nA node named %s has entered the trigger\n", node->getName());
}

WorldTriggerPtr trigger;

int AppWorldLogic::init() {

	// create a world trigger node
	trigger = WorldTrigger::create(Math::vec3(3.0f));
	
	// add the enter callback to be fired when a node enters the world trigger
	trigger->addEnterCallback(MakeCallback(this, &AppWorldLogic::enter_callback));
	
	return 1;
}

Arguments

Unigine::CallbackBase1< Ptr<Node> > * func - Callback pointer.

Return value

ID of the last added enter callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

bool removeEnterCallback ( void * id ) #

Removes the specified callback from the list of enter callbacks.

Arguments

void * id - Enter callback ID obtained when adding it.

Return value

True if the enter callback with the given ID was removed successfully; otherwise false.

void clearEnterCallbacks ( ) #

Clears all added enter callbacks.

void setEnterCallbackName ( const char * name ) #

Sets a callback function to be fired when nodes are entering the world trigger. Unlike setEnterCallback(), this callback function accepts a node that entered the world trigger and world trigger itself as arguments.

Arguments

const char * name - World script function name.

const char * getEnterCallbackName ( ) const#

Returns the name of callback function to be fired on entering the world trigger. This callback function is set via setEnterCallbackName().

Return value

World script function name.

void setExcludeNodes ( const Set< Ptr<Node> > & nodes ) #

Sets a list of excluded nodes, on which the world trigger will not react.

Arguments

const Set< Ptr<Node> > & nodes - Exclude nodes vector.

Set< Ptr<Node> > getExcludeNodes ( ) const#

Returns the current list of excluded nodes, on which the world trigger does not react.

Arguments

void setExcludeTypes ( const Set< int > & types ) #

Sets a list of excluded node types, on which the world trigger will not react.

Arguments

const Set< int > & types - Exclude node types vector.

Set< int > getExcludeTypes ( ) const#

Returns the current list of excluded node types, on which the world trigger does not react.

Arguments

void * addLeaveCallback ( Unigine::CallbackBase1< Ptr<Node> > * func ) #

Adds a callback function to be fired when a node leaves the world trigger. The callback function must receive a Node as its first argument. In addition, it can also take 2 arguments of any type.

Source code (C++)

// implement the leave callback
void AppWorldLogic::leave_callback(NodePtr node){
	Log::message("\nA node named %s has left the trigger\n", node->getName());
}

WorldTriggerPtr trigger;

int AppWorldLogic::init() {

	// create a world trigger node
	trigger = WorldTrigger::create(Math::vec3(3.0f));
	
	// add the leave callback to be fired when a node leaves the world trigger
	trigger->addLeaveCallback(MakeCallback(this, &AppWorldLogic::leave_callback));
	
	return 1;
}

Arguments

Unigine::CallbackBase1< Ptr<Node> > * func - Callback pointer.

Return value

ID of the last added leave callback, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

bool removeLeaveCallback ( void * id ) #

Removes the specified callback from the list of leave callbacks.

Arguments

void * id - Leave callback ID obtained when adding it.

Return value

True if the leave callback with the given ID was removed successfully; otherwise false.

void clearLeaveCallbacks ( ) #

Clears all added leave callbacks.

void setLeaveCallbackName ( const char * name ) #

Sets a callback function to be fired when nodes are leaving the world trigger. Unlike setLeaveCallback(), this callback function accepts a node that left the world trigger and world trigger itself as arguments.

Arguments

const char * name - World script function name.

const char * getLeaveCallbackName ( ) const#

Returns the name of the callback function name to be fired on leaving the world trigger. This callback function is set via setLeaveCallbackName().

Return value

World script function name.

Ptr<Node> getNode ( int num ) const#

Returns a specified node contained in the world trigger.

Source code (C#)

using Unigine;

namespace UnigineApp
{
	class AppWorldLogic : WorldLogic
	{
		WorldTrigger trigger;

		public override bool Init()
		{
			// create a world trigger
            trigger = new WorldTrigger(new vec3(3.0f));

			return true;
		}

		public override bool Update()
		{
			// press the i key to get the info about nodes inside the trigger
			if (trigger != null && Input.IsKeyDown(Input.KEY.I))
			{
				//get the number of nodes inside the trigger
				int numNodes = trigger.NumNodes;
				Unigine.Log.Message("The number of nodes inside the trigger is " + numNodes + "\n");

				//loop through all nodes to print their names and types
				for (int i = 0; i < numNodes; i++)
				{
					Node node = trigger.GetNode(i); 
					Unigine.Log.Message("The type of the " + node.Name + " node is " + node.Type + "\n");
				}
			}

			return true;
		}
	}
}

Arguments

int num - Node number in range from 0 to the total number of nodes.

Return value

Node pointer.

Vector< Ptr<Node> > getNodes ( ) const#

Gets nodes contained in the trigger.

Arguments

int getNumNodes ( ) const#

Returns the number of nodes contained in the world trigger.

Return value

Number of nodes contained in the trigger.

void setSize ( const Math::vec3 & size ) #

Updates the current dimensions of the world trigger. The minimum size is vec3(0,0,0).

Arguments

const Math::vec3 & size - Dimensions of the world trigger. If negative values are provided, 0 will be used instead of them.

Math::vec3 getSize ( ) const#

Returns the current dimensions of the world trigger.

Return value

Current dimensions of the world trigger.

void setTargetNodes ( const Set< Ptr<Node> > & nodes ) #

Sets a list of target nodes, which will fire callbacks. If this list is empty, all nodes fire callbacks.

Arguments

const Set< Ptr<Node> > & nodes - Target nodes vector.

Set< Ptr<Node> > getTargetNodes ( ) const#

Returns the current list of target nodes, which fire callbacks. If this list is empty, all nodes fire callbacks.

Arguments

void setTargetTypes ( const Set< int > & types ) #

Sets a list of target node types, which will fire callbacks. If this list is empty, all nodes fire callbacks.

Arguments

const Set< int > & types - Target node types vector.

Set< int > getTargetTypes ( ) const#

Returns the current list of target node types, which fire callbacks. If this list is empty, all nodes fire callbacks.

Arguments

void setTouch ( bool touch ) #

Sets a touch mode for the trigger. With this mode on, the trigger will react to the node by partial contact. When set to off, the trigger reacts only if the whole bounding sphere/box gets inside or outside of it. The default is 0.

Arguments

bool touch - Touch mode flag: true to enable the touch mode, false to disable it.

bool isTouch ( ) const#

Returns a value indicating if a touch mode is enabled for the trigger. With this mode on, the trigger will react to the node by partial contact. When set to off, the trigger reacts only if the whole bounding sphere/box gets inside or outside of it.

Return value

true if the touch mode is enabled; otherwise, false.

static int type ( ) #

Returns the type of the node.

Return value

World type identifier.

Last update: 09.04.2021

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter

Unigine::WorldTrigger Class

See Also#

Methods:

WorldTrigger Class

Members

static WorldTriggerPtr create ( const Math::vec3 & size ) #

Arguments

void * addEnterCallback ( Unigine::CallbackBase1< Ptr<Node> > * func ) #

Arguments

Return value

bool removeEnterCallback ( void * id ) #

Arguments

Return value

void clearEnterCallbacks ( ) #

void setEnterCallbackName ( const char * name ) #

Arguments

const char * getEnterCallbackName ( ) const#

Return value

void setExcludeNodes ( const Set< Ptr<Node> > & nodes ) #

Arguments

Set< Ptr<Node> > getExcludeNodes ( ) const#

Arguments

void setExcludeTypes ( const Set< int > & types ) #

Arguments

Set< int > getExcludeTypes ( ) const#

Arguments

void * addLeaveCallback ( Unigine::CallbackBase1< Ptr<Node> > * func ) #

Arguments

Return value

bool removeLeaveCallback ( void * id ) #

Arguments

Return value

void clearLeaveCallbacks ( ) #

void setLeaveCallbackName ( const char * name ) #

Arguments

const char * getLeaveCallbackName ( ) const#

Return value

Ptr<Node> getNode ( int num ) const#

Arguments

Return value

Vector< Ptr<Node> > getNodes ( ) const#

Arguments

int getNumNodes ( ) const#

Return value

void setSize ( const Math::vec3 & size ) #

Arguments

Math::vec3 getSize ( ) const#

Return value

void setTargetNodes ( const Set< Ptr<Node> > & nodes ) #

Arguments

Set< Ptr<Node> > getTargetNodes ( ) const#

Arguments

void setTargetTypes ( const Set< int > & types ) #

Arguments

Set< int > getTargetTypes ( ) const#

Arguments

void setTouch ( bool touch ) #

Arguments

bool isTouch ( ) const#

Return value

static int type ( ) #

Return value