Detailed Description

A spotlight, such as a spotlight or a lantern.

Inheritance diagram for SpotLight:

Public Member Functions
	SpotLight (const std::string &name=TypeNames[SPOT_LIGHT])

	SpotLight (float cutOffDegrees, float outerCutOffDegrees, float range, const float4 &color={1.0f, 1.0f, 1.0f, 1.0f}, const std::string &nodeName=TypeNames[SPOT_LIGHT])

	SpotLight (const SpotLight &spotLight)

	~SpotLight () override = default

void	setCutOff (float cutOffDegrees)

auto	getCutOff () const

void	setOuterCutOff (float outerCutOffDegrees)

auto	getOuterCutOff () const

void	setProperty (const std::string &property, const std::string &value) override

void	setLuaThis () override

Public Member Functions inherited from OmniLight
	OmniLight (const std::string &name=TypeNames[OMNI_LIGHT], Type type=OMNI_LIGHT)

	OmniLight (float range, const float4 &color={1.0f, 1.0f, 1.0f, 1.0f}, const std::string &nodeName=TypeNames[OMNI_LIGHT], Type type=OMNI_LIGHT)

	OmniLight (const OmniLight &omniLight)

	~OmniLight () override = default

auto	getRange () const

void	setRange (float range)

auto	getNearClipDistance () const

void	setProperty (const std::string &property, const std::string &value) override

std::shared_ptr< Node >	copy () const override

void	setLuaThis () override

Public Member Functions inherited from Light
	~Light () override = default

auto	getColorAndIntensity () const

void	setColorAndIntensity (const float4 &colorAndIntensity)

auto	getCastShadows () const

void	setCastShadows (bool castShadows)

auto	getLightType () const

auto	getShadowMapSize () const

void	setShadowMapSize (const int32 shadowMapSize)

auto	getShadowTransparencyScissors () const

auto	setShadowTransparencyScissors (const float scissors)

auto	getShadowTransparencyColorScissors () const

auto	setShadowTransparencyColorScissors (const float scissors)

void	setProperty (const std::string &property, const std::string &value) override

void	updateGlobalTransform () override

Public Member Functions inherited from Node
	Node (const Node &node)

	Node (const std::string &name=TypeNames[NODE], Type type=NODE)

virtual	~Node () = default

auto	getId () const

virtual void	onReady ()

virtual void	onEnterScene ()

virtual void	onExitScene ()

virtual void	onProcess (const float alpha)

virtual void	onPhysicsProcess (const float delta)

virtual bool	onInput (const InputEvent &inputEvent)

const float4x4 &	getTransform () const

void	setTransform (const float4x4 &transform)

const float4x4 &	getTransformGlobal () const

virtual void	setPosition (const float3 &position)

virtual void	setPosition (const float x, const float y, const float z)

float3	getPosition () const

void	translate (const float3 &localOffset)

void	translate (const float x, const float y, const float z)

virtual void	setPositionGlobal (const float3 &position)

virtual void	setPositionGlobal (const float x, const float y, const float z)

float3	getPositionGlobal () const

void	rotate (const quaternion &quaternion)

void	rotateX (float angle)

void	rotateY (float angle)

void	rotateZ (float angle)

void	rotateGlobalX (float angle)

void	rotateGlobalY (float angle)

void	rotateGlobalZ (float angle)

quaternion	getRotation () const

quaternion	getRotationGlobal () const

float3	getRotationEulerAngles () const

float3	getRotationEulerAnglesGlobal () const

virtual void	scale (float scale)

void	setScale (const float3 &scale)

void	setRotation (const quaternion &quat)

void	setRotationGlobal (const quaternion &quat)

void	setRotation (const float3 &rot)

void	setRotationX (float angle)

void	setRotationY (float angle)

void	setRotationZ (float angle)

float	getRotationX () const

float	getRotationY () const

float	getRotationZ () const

float	getRotationGlobalX () const

float	getRotationGlobalY () const

float	getRotationGlobalZ () const

void	setRotationGlobalX (float angle)

void	setRotationGlobalY (float angle)

void	setRotationGlobalZ (float angle)

float3	getScale () const

float3	getScaleGlobal () const

template<typename T = Node>
const std::shared_ptr< T > &	addChild (const std::shared_ptr< T > &child, bool async=false)

template<typename T = Node>
bool	removeChild (const std::shared_ptr< T > &child)

void	removeAllChildren (bool async=false)

void	lookAt (const float3 &target)

template<typename T = Node>
std::list< std::shared_ptr< T > >	findAllChildrenByGroup (const std::string &groupName, const bool recursive=true) const

const std::list< std::string > &	getGroups () const

void	addToGroup (const std::string &group)

void	removeFromGroup (const std::string &group)

virtual bool	isVisible () const

virtual void	setVisible (bool visible=true)

bool	isInGroup (const std::string &group) const

void	setProcessMode (const ProcessMode mode)

bool	isProcessed () const

auto	getType () const

std::string	getPath () const

virtual void	setProperty (const std::string &property, const std::string &value)

void	printTree (int tab=0) const

std::shared_ptr< Node >	duplicate (bool recursiveFilter=false) const

float3	toGlobal (const float3 &local) const

float3	toLocal (const float3 &global) const

float3	getRightVector () const

float3	getLeftVector () const

float3	getFrontVector () const

float3	getBackVector () const

float3	getUpVector () const

float3	getDownVector () const

template<typename T >
bool	haveChild (const std::shared_ptr< T > &child, const bool recursive=true) const

template<typename T = Node>
std::shared_ptr< T >	getChild (const std::string &name) const

template<typename T = Node>
std::shared_ptr< T >	getChildByPath (const std::string &path) const

template<typename T = Node>
std::string	getRelativePath (const std::shared_ptr< T > &root) const

template<typename T = Node>
std::shared_ptr< T >	findFirstChild (const std::string &name) const

template<typename T >
std::shared_ptr< T >	findFirstChild (const bool recursive=true) const

template<typename T >
std::list< std::shared_ptr< T > >	findAllChildren (const bool recursive=true) const

template<typename T = Node>
std::list< std::shared_ptr< T > >	findAllChildren (const std::string &name, const bool recursive=true) const

const std::list< std::shared_ptr< Node > > &	getChildren ()

const std::list< std::shared_ptr< Node > > &	getChildren () const

void	setName (const std::string &nodeName)

template<typename T = Node>
std::shared_ptr< T >	getSharedPtr ()

const std::string &	getName () const

template<typename T = Scene>
T *	getScene () const

const auto &	getParent () const

bool	haveParent () const

virtual std::shared_ptr< Node >	copy () const

void	setLuaThis () override

Protected Member Functions
std::shared_ptr< Node >	copy () const override

Protected Member Functions inherited from Light
	Light (const std::string &nodeName=TypeNames[LIGHT], Type type=LIGHT)

	Light (const float4 &color, const std::string &nodeName=TypeNames[LIGHT], Type type=LIGHT)

	Light (const Light &light)

std::shared_ptr< Node >	copy () const override

Protected Member Functions inherited from Node
virtual void	updateGlobalTransform ()

Additional Inherited Members
Public Types inherited from Node
enum	Type { ANIMATION_PLAYER, CAMERA, CHARACTER, COLLISION_AREA, COLLISION_OBJECT, DIRECTIONAL_LIGHT, ENVIRONMENT, KINEMATIC_BODY, LIGHT, MESH_INSTANCE, NODE, OMNI_LIGHT, PHYSICS_BODY, RAYCAST, RIGID_BODY, SKYBOX, SPOT_LIGHT, STATIC_BODY, VIEWPORT }
	Node type. More...

Static Public Member Functions inherited from Node
static std::string	sanitizeName (const std::string &name)

Static Public Attributes inherited from Light
static constexpr auto	MAX_LIGHTS {100}

Static Public Attributes inherited from Node
static constexpr auto	TypeNames
	Display names for each node Type value, indexed by the Type enum. More...

Protected Attributes inherited from Node
float4x4	localTransform {}

float4x4	globalTransform {}

Scene *	scene {nullptr}

Constructor & Destructor Documentation

SpotLight ( const std::string & name = TypeNames[SPOT_LIGHT] )

Creates a SpotLight with default parameters

SpotLight	(	float	cutOffDegrees,
		float	outerCutOffDegrees,
		float	range,
		const float4 &	color = `{1.0f, 1.0f, 1.0f, 1.0f}`,
		const std::string &	nodeName = `TypeNames[SPOT_LIGHT]`
	)

Create a SpotLight.

Parameters

cutOffDegrees	the inner cutoff angle that specifies the spotlight's radius, in degrees
outerCutOffDegrees	the outer cutoff angle that specifies the spotlight's radius, in degrees. Everything outside this angle is not lit by the spotlight.
range	Radius of the light and shadows
color	the RGB color and intensity
nodeName	Node name

SpotLight ( const SpotLight & spotLight )

Copy constructor — creates an independent spot-light node with the same cone angles and range.

~SpotLight ( )

overridedefault

Member Function Documentation

std::shared_ptr<Node> copy ( ) const

overrideprotected

auto getCutOff ( ) const

inline

Returns the inner cutoff value that specifies the spotlight's radius (not the angle!)

auto getOuterCutOff ( ) const

inline

Returns the outer cutoff value that specifies the spotlight's radius (not the angle!).

void setCutOff ( float cutOffDegrees )

Sets the inner cutoff angle that specifies the spotlight's radius, in degrees

void setLuaThis ( )

override

void setOuterCutOff ( float outerCutOffDegrees )

Sets the outer cutoff angle that specifies the spotlight's radius. Everything outside this angle is not lit by the spotlight.

void setProperty	(	const std::string &	property,
		const std::string &	value
	)

override

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation