core::ClipPlane Class Reference

#include <ClipPlane.h>

Inheritance diagram for core::ClipPlane:

Collaboration diagram for core::ClipPlane:

Public Member Functions
	ClipPlane (const Plane &plane)
	Constructor. More...
	ClipPlane ()=default
	Default constructor defined internally. More...
	ClipPlane (const size_t id, const Plane &plane)
	Constructor with id and plane defined internally. More...
size_t	getID () const
	Returns id of this clip plane object. More...
const Plane &	getPlane () const
	Returns the constant reference to the Plane object of this clip plane object. More...
void	setPlane (const Plane &plane)
	Sets the Plane object of this clip plane object. More...
Public Member Functions inherited from core::BaseObject
	BaseObject ()=default
virtual	~BaseObject ()=default
	BaseObject (const BaseObject &)
BaseObject &	operator= (const BaseObject &rhs)
bool	isModified () const
void	resetModified ()
void	markModified (const bool triggerCallback=true)
void	onModified (const ModifiedCallback &callback)
void	clearModifiedCallback ()

Additional Inherited Members
Public Types inherited from core::BaseObject
using	ModifiedCallback = std::function< void(const BaseObject &)>
Protected Member Functions inherited from core::BaseObject
template<typename T >
void	_updateValue (T &member, const T &newValue, const bool triggerCallback=true)
template<class T >
bool	_isEqual (const T &a, const T &b, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)
template<class T >
bool	_isEqual (const T &a, const T &b, typename std::enable_if<!std::is_floating_point< T >::value >::type *=0)

Detailed Description

Definition at line 31 of file ClipPlane.h.

Constructor & Destructor Documentation

ClipPlane() [1/3]

core::ClipPlane::ClipPlane ( const Plane &  plane )

inline

Constructor.

Parameters

plane

A constant reference to Plane object.

Definition at line 38 of file ClipPlane.h.

ClipPlane() [2/3]

core::ClipPlane::ClipPlane ( )

default

Default constructor defined internally.

ClipPlane() [3/3]

core::ClipPlane::ClipPlane	(	const size_t	id,
		const Plane &	plane
	)

Constructor with id and plane defined internally.

Parameters

id	A size_t representing the ID of this clip plane object.
plane	A constant reference to the Plane object.

Member Function Documentation

getID()

size_t core::ClipPlane::getID ( ) const

inline

Returns id of this clip plane object.

Returns

size_t The id of the clip plane object.

Definition at line 60 of file ClipPlane.h.

getPlane()

const Plane& core::ClipPlane::getPlane ( ) const

inline

Returns the constant reference to the Plane object of this clip plane object.

Returns

const Plane& A reference to the constant Plane object of this clip plane object.

Definition at line 66 of file ClipPlane.h.

setPlane()

void core::ClipPlane::setPlane ( const Plane &  plane )

inline

Sets the Plane object of this clip plane object.

Parameters

plane

A constant reference to the Plane object to be set.

Definition at line 72 of file ClipPlane.h.

---

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

• platform/core/common/scene/ClipPlane.h
• platform/core/common/scene/ClipPlane.cpp