UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

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 flush() (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.

See Also#

  • A C++ API sample located in the <UnigineSDK>/source/samples/Api/Nodes/WorldTrigger folder
  • A C# API sample located in the <UnigineSDK>/source/csharp/samples/Api/Nodes/WorldTrigger folder
  • A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/worlds/ folder:
    • trigger_00
    • trigger_01
    • trigger_02

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.

Ptr<WorldTrigger> cast( const Ptr<Node> & node )

Casts a WorldTrigger out of the Node instance.

Arguments

  • const Ptr<Node> & node - Pointer to Node.

Return value

Pointer to WorldTrigger.

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( )

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( )

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( )

    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( )

      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 )

      Returns a node pointer.

      Arguments

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

      Return value

      Node pointer.

      Ptr<Node> getNode( )

      Returns a node pointer.

      Return value

      Node pointer.

      Vector< Ptr<Node> > getNodes( )

      Gets nodes contained in the trigger.

      Arguments

        int getNumNodes( )

        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.

        Math::vec3 getSize( )

        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( )

        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( )

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

          Arguments

            void setTouch( int 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

            • int touch - Touch mode flag: 1 to enable the touch mode, 0 to disable it.

            int isTouch( )

            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

            Returns 1 if the touch mode is enabled; otherwise, 0.

            int type( )

            Returns the type of the node.

            Return value

            World type identifier.
            Last update: 2019-04-04