igor::iGlobalBoundaryComponent Class Reference

#include <iGlobalBoundaryComponent.h>

Inherits igor::iEntityComponent.

Public Member Functions

 iGlobalBoundaryComponent (iGlobalBoundaryType type=iGlobalBoundaryType::Normal)
 
iGlobalBoundaryType getType () const
 
void setType (iGlobalBoundaryType type)
 
std::vector< iaStringgetInfo () const override
 
- Public Member Functions inherited from igor::iEntityComponent
 iEntityComponent ()
 
virtual ~iEntityComponent ()=default
 
const iEntityComponentIDgetID () const
 
iEntityComponentState getState () const
 
virtual std::vector< iaStringgetInfo () const
 
IGOR_INLINE void setDirty ()
 
uint16 getVersion () const
 

Static Public Member Functions

static iEntityComponentcreateInstance ()
 
static const iaStringgetTypeName ()
 

Additional Inherited Members

- Protected Member Functions inherited from igor::iEntityComponent
virtual bool onLoad (iEntityPtr entity, bool &asyncLoad)
 
virtual void onActivate (iEntityPtr entity)
 
virtual void onDeactivate (iEntityPtr entity)
 
virtual void onUnLoad (iEntityPtr entity)
 
virtual iEntityComponentPtr getCopy ()=0
 
iEntityPtr getEntity () const
 

Detailed Description

keeps entities within some global boundaries

check the scene interface for configuring the global boundaries

Constructor & Destructor Documentation

◆ iGlobalBoundaryComponent()

igor::iGlobalBoundaryComponent::iGlobalBoundaryComponent ( iGlobalBoundaryType  type = iGlobalBoundaryType::Normal)

ctor

Parameters
typethe type to set

Member Function Documentation

◆ createInstance()

iEntityComponent * igor::iGlobalBoundaryComponent::createInstance ( )
static

creates instance of this component type

◆ getInfo()

std::vector< iaString > igor::iGlobalBoundaryComponent::getInfo ( ) const
overridevirtual
Returns
a set of info strings

Reimplemented from igor::iEntityComponent.

◆ getType()

iGlobalBoundaryType igor::iGlobalBoundaryComponent::getType ( ) const
Returns
global boundary type

◆ getTypeName()

const iaString & igor::iGlobalBoundaryComponent::getTypeName ( )
static
Returns
type name of component

◆ setType()

void igor::iGlobalBoundaryComponent::setType ( iGlobalBoundaryType  type)

sets global boundary type

Parameters
typethe type to set

The documentation for this class was generated from the following files: