CLRadialGradient Class Reference

#include <CLRadialGradient.h>

Inheritance diagram for CLRadialGradient:

Public Member Functions
	CLRadialGradient (CDataContainer *pParent=NULL)
	CLRadialGradient (const CLRadialGradient &source, CDataContainer *pParent=NULL)
	CLRadialGradient (const RadialGradient &source, CDataContainer *pParent=NULL)
CLRelAbsVector &	getCenterX ()
const CLRelAbsVector &	getCenterX () const
CLRelAbsVector &	getCenterY ()
const CLRelAbsVector &	getCenterY () const
CLRelAbsVector &	getCenterZ ()
const CLRelAbsVector &	getCenterZ () const
CLRelAbsVector &	getFocalPointX ()
const CLRelAbsVector &	getFocalPointX () const
CLRelAbsVector &	getFocalPointY ()
const CLRelAbsVector &	getFocalPointY () const
CLRelAbsVector &	getFocalPointZ ()
const CLRelAbsVector &	getFocalPointZ () const
CLRelAbsVector &	getRadius ()
const CLRelAbsVector &	getRadius () const
void	setCenter (const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z=CLRelAbsVector(0.0, 0.0))
void	setCoordinates (const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &r, const CLRelAbsVector &fx, const CLRelAbsVector &fy)
void	setCoordinates (const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z, const CLRelAbsVector &r, const CLRelAbsVector &fx, const CLRelAbsVector &fy, const CLRelAbsVector &fz)
void	setFocalPoint (const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z=CLRelAbsVector(0.0, 0.0))
void	setRadius (const CLRelAbsVector &r)
virtual RadialGradient *	toSBML (unsigned int level, unsigned int version) const
Public Member Functions inherited from CLGradientBase
void	addGradientStop (const CLGradientStop *pStop)
virtual void	addSBMLAttributes (GradientBase *pBase) const
virtual bool	applyData (const CData &data, CUndoData::CChangeSet &changes)
	CLGradientBase (const CLGradientBase &source, CDataContainer *pParent=NULL)
	CLGradientBase (const GradientBase &source, const std::string &name, CDataContainer *pParent=NULL)
	CLGradientBase (const std::string &name, CDataContainer *pParent=NULL)
CLGradientStop *	createGradientStop ()
CLGradientStop *	getGradientStop (size_t i)
const CLGradientStop *	getGradientStop (size_t i) const
const std::string &	getId () const
const std::string &	getKey () const
CDataVector< CLGradientStop > *	getListOfGradientStops ()
const CDataVector< CLGradientStop > *	getListOfGradientStops () const
size_t	getNumGradientStops () const
SPREADMETHOD	getSpreadMethod () const
void	setId (const std::string &id)
void	setSpreadMethod (SPREADMETHOD method)
virtual CData	toData () const
virtual	~CLGradientBase ()
Public Member Functions inherited from CLBase
	CLBase ()
	CLBase (const CLBase &b)
	CLBase (const SBase &)
const std::string &	getTag () const
bool	hasTag () const
virtual void	moveBy (const CLPoint &)
void	setTag (const std::string &tag)
virtual	~CLBase ()
Public Member Functions inherited from CDataContainer
virtual bool	add (CDataObject *pObject, const bool &adopt=true)
virtual bool	appendDeletedDependentData (CUndoData &undoData) const
	CDataContainer (const CDataContainer &src, const CDataContainer *pParent)
	CDataContainer (const std::string &name, const CDataContainer *pParent=NO_PARENT, const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)
virtual void	createUndoData (CUndoData &undoData, const CUndoData::Type &type, const CData &oldData=CData(), const CCore::Framework &framework=CCore::Framework::ParticleNumbers) const override
virtual std::string	getChildObjectUnits (const CDataObject *pObject) const
void	getDescendants (CDataObject::DataObjectSet &descendants, const bool &recursive=false) const
virtual size_t	getIndex (const CDataObject *pObject) const
virtual const CObjectInterface *	getObject (const CCommonName &cn) const override
virtual objectMap &	getObjects ()
virtual const objectMap &	getObjects () const
virtual const std::string	getUnits () const override
virtual const CDataObject *	getValueObject () const override
virtual CUndoObjectInterface *	insert (const CData &data) override
void	objectRenamed (CDataObject *pObject, const std::string &oldName)
virtual bool	remove (CDataObject *pObject)
virtual	~CDataContainer ()
Public Member Functions inherited from CDataObject
void	addIssue (const CIssue &issue)
void	addReference (const CDataContainer *pReference)
virtual void	calculateValue () override
	CDataObject (const CDataObject &src, const CDataContainer *pParent=NULL)
virtual void	destruct () override
virtual CCommonName	getCN () const override
virtual const CDataObject *	getDataObject () const override
CDataContainer *	getObjectAncestor (const std::string &type) const
CDataModel *	getObjectDataModel () const
virtual std::string	getObjectDisplayName () const override
const CObjectInterface *	getObjectFromCN (const CCommonName &cn) const
const std::string &	getObjectName () const
CDataContainer *	getObjectParent () const
const std::string &	getObjectType () const
virtual const CObjectInterface::ObjectSet &	getPrerequisites () const override
virtual const CValidity &	getValidity () const override
virtual void *	getValuePointer () const override
bool	hasFlag (const Flag &flag) const
virtual bool	isPrerequisiteForContext (const CObjectInterface *pObject, const CCore::SimulationContextFlag &context, const CObjectInterface::ObjectSet &changedObjects) const override
bool	prerequisitsContains (const DataObjectSet &objects) const
virtual void	print (std::ostream *ostream) const override
void	removeIssue (const CIssue &issue)
void	removeReference (const CDataContainer *pReference)
bool	setObjectName (const std::string &name)
virtual bool	setObjectParent (const CDataContainer *pParent)
void	validityChanged (const CValidity &changedValidity) override
void	validityRemoved (const CValidity &changedValidity)
virtual	~CDataObject ()
Public Member Functions inherited from CObjectInterface
	CObjectInterface ()
	CObjectInterface (const CObjectInterface &src)
virtual	~CObjectInterface ()
Public Member Functions inherited from CUndoObjectInterface
	CUndoObjectInterface ()
	CUndoObjectInterface (const CUndoObjectInterface &src)
bool	generateUuid ()
const xg::Guid &	getUuid () const
bool	setUuid (const std::string &uuid)
bool	setUuid (const xg::Guid &uuid)
virtual void	updateIndex (const size_t &index, const CUndoObjectInterface *pUndoObject)
virtual	~CUndoObjectInterface ()

Protected Attributes
CLRelAbsVector	mCX
CLRelAbsVector	mCY
CLRelAbsVector	mCZ
CLRelAbsVector	mFX
CLRelAbsVector	mFY
CLRelAbsVector	mFZ
CLRelAbsVector	mRadius
Protected Attributes inherited from CLGradientBase
CDataVector< CLGradientStop >	mGradientStops
std::string	mId
std::string	mKey
SPREADMETHOD	mSpreadMethod
Protected Attributes inherited from CLBase
std::string	mTag
Protected Attributes inherited from CDataContainer
objectMap	mObjects
Protected Attributes inherited from CDataObject
ObjectSet	mPrerequisits
std::set< CDataContainer * >	mReferences
Protected Attributes inherited from CObjectInterface
CValidity	mValidity

Private Member Functions
CLRadialGradient &	operator= (const CLRadialGradient &source)

Additional Inherited Members
Public Types inherited from CLGradientBase
enum	SPREADMETHOD { PAD , REFLECT , REPEAT }
Public Types inherited from CDataContainer
typedef CDataObjectMap	objectMap
Public Types inherited from CDataObject
typedef std::set< const CDataObject * >	DataObjectSet
enum	Flag {   Container , Vector , Matrix , NameVector ,   Reference , ValueBool , ValueInt , ValueInt64 ,   ValueDbl , NonUniqueName , StaticString , ValueString ,   Separator , DisplayName , ModelEntity , Array ,   DataModel , Root , Gui , __SIZE }
Public Types inherited from CObjectInterface
typedef std::vector< const CDataContainer * >	ContainerList
typedef std::set< const CObjectInterface * >	ObjectSet
Static Public Member Functions inherited from CLGradientBase
static CLGradientBase *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CDataContainer
static CDataContainer *	fromData (const CData &data, CUndoObjectInterface *pParent)
Static Public Member Functions inherited from CDataObject
static CDataObject *	fromData (const CData &data, CUndoObjectInterface *pParent)
static void	sanitizeObjectName (std::string &name)
Static Public Member Functions inherited from CObjectInterface
static const CDataObject *	DataObject (const CObjectInterface *pInterface)
static CObjectInterface *	GetObjectFromCN (const ContainerList &listOfContainer, const CCommonName &objName)
Static Public Member Functions inherited from CUndoObjectInterface
template<class CType >
static CType *	fromData (const CData &, CUndoObjectInterface *)
Static Public Attributes inherited from CDataContainer
static const CObjectInterface::ContainerList	EmptyList
Protected Member Functions inherited from CDataContainer
template<class CType >
CDataMatrixReference< CType > *	addMatrixReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
template<class CType >
CDataObjectReference< CType > *	addObjectReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
template<class CType >
CDataVectorReference< CType > *	addVectorReference (const std::string &name, CType &reference, const CFlags< Flag > &flag=CFlags< Flag >::None)
	CDataContainer (const CDataContainer &src)
void	initObjects ()
Protected Member Functions inherited from CDataObject
	CDataObject ()
	CDataObject (const std::string &name, const CDataContainer *pParent=static_cast< CDataContainer * >((void *) 0), const std::string &type="CN", const CFlags< Flag > &flag=CFlags< Flag >::None)

Constructor & Destructor Documentation

CLRadialGradient() [1/3]

CLRadialGradient::CLRadialGradient

(

CDataContainer *

pParent = NULL

)

Constructor.

References CKeyFactory::add(), CRootContainer::getKeyFactory(), and CLGradientBase::mKey.

CLRadialGradient() [2/3]

CLRadialGradient::CLRadialGradient	(	const CLRadialGradient &	source,
		CDataContainer *	pParent = NULL
	)

Copy Constructor.

References CKeyFactory::add(), CRootContainer::getKeyFactory(), and CLGradientBase::mKey.

CLRadialGradient() [3/3]

CLRadialGradient::CLRadialGradient	(	const RadialGradient &	source,
		CDataContainer *	pParent = NULL
	)

Constructor to generate object from the corresponding SBML object.

References CKeyFactory::add(), CRootContainer::getKeyFactory(), and CLGradientBase::mKey.

Member Function Documentation

getCenterX() [1/2]

CLRelAbsVector & CLRadialGradient::getCenterX

(

)

Returns the x coordinate for the center point.

References mCX.

getCenterX() [2/2]

const CLRelAbsVector & CLRadialGradient::getCenterX

(

)

const

Returns the x coordinate for the center point.

References mCX.

Referenced by CLLayoutRenderer::create_radial_gradient_texture(), CCopasiXML::saveRadialGradient(), and toSBML().

getCenterY() [1/2]

CLRelAbsVector & CLRadialGradient::getCenterY

(

)

Returns the y coordinate for the center point.

References mCY.

getCenterY() [2/2]

const CLRelAbsVector & CLRadialGradient::getCenterY

(

)

const

Returns the y coordinate for the center point.

References mCY.

Referenced by CLLayoutRenderer::create_radial_gradient_texture(), CCopasiXML::saveRadialGradient(), and toSBML().

getCenterZ() [1/2]

CLRelAbsVector & CLRadialGradient::getCenterZ

(

)

Returns the z coordinate for the center point.

References mCZ.

getCenterZ() [2/2]

const CLRelAbsVector & CLRadialGradient::getCenterZ

(

)

const

Returns the z coordinate for the center point.

References mCZ.

Referenced by CCopasiXML::saveRadialGradient(), and toSBML().

getFocalPointX() [1/2]

CLRelAbsVector & CLRadialGradient::getFocalPointX

(

)

Returns the x coordinate for the focal point.

References mFX.

getFocalPointX() [2/2]

const CLRelAbsVector & CLRadialGradient::getFocalPointX

(

)

const

Returns the x coordinate for the focal point.

References mFX.

Referenced by CLLayoutRenderer::create_radial_gradient_texture(), CCopasiXML::saveRadialGradient(), and toSBML().

getFocalPointY() [1/2]

CLRelAbsVector & CLRadialGradient::getFocalPointY

(

)

Returns the x coordinate for the focal point.

References mFY.

getFocalPointY() [2/2]

const CLRelAbsVector & CLRadialGradient::getFocalPointY

(

)

const

Returns the x coordinate for the focal point.

References mFY.

Referenced by CLLayoutRenderer::create_radial_gradient_texture(), CCopasiXML::saveRadialGradient(), and toSBML().

getFocalPointZ() [1/2]

CLRelAbsVector & CLRadialGradient::getFocalPointZ

(

)

Returns the x coordinate for the focal point.

References mFZ.

getFocalPointZ() [2/2]

const CLRelAbsVector & CLRadialGradient::getFocalPointZ

(

)

const

Returns the x coordinate for the focal point.

References mFZ.

Referenced by CCopasiXML::saveRadialGradient(), and toSBML().

getRadius() [1/2]

CLRelAbsVector & CLRadialGradient::getRadius

(

)

Returns the radius.

References mRadius.

getRadius() [2/2]

const CLRelAbsVector & CLRadialGradient::getRadius

(

)

const

Returns the radius.

References mRadius.

Referenced by CLLayoutRenderer::create_radial_gradient_texture(), CCopasiXML::saveRadialGradient(), and toSBML().

operator=()

CLRadialGradient& CLRadialGradient::operator= ( const CLRadialGradient &  source )

private

setCenter()

void CLRadialGradient::setCenter	(	const CLRelAbsVector &	x,
		const CLRelAbsVector &	y,
		const CLRelAbsVector &	z = CLRelAbsVector(0.0, 0.0)
	)

Sets the coordinates for the first point.

References mCX, mCY, and mCZ.

Referenced by RadialGradientHandler::processStart(), and setCoordinates().

setCoordinates() [1/2]

void CLRadialGradient::setCoordinates	(	const CLRelAbsVector &	x,
		const CLRelAbsVector &	y,
		const CLRelAbsVector &	r,
		const CLRelAbsVector &	fx,
		const CLRelAbsVector &	fy
	)

Sets the 2D coordinates for center and the focal point as well as the radius.

References setCoordinates().

setCoordinates() [2/2]

void CLRadialGradient::setCoordinates	(	const CLRelAbsVector &	x,
		const CLRelAbsVector &	y,
		const CLRelAbsVector &	z,
		const CLRelAbsVector &	r,
		const CLRelAbsVector &	fx,
		const CLRelAbsVector &	fy,
		const CLRelAbsVector &	fz
	)

Sets the 3D coordinates for the center and the focal point as well as the radius.

References setCenter(), setFocalPoint(), and setRadius().

Referenced by setCoordinates().

setFocalPoint()

void CLRadialGradient::setFocalPoint	(	const CLRelAbsVector &	x,
		const CLRelAbsVector &	y,
		const CLRelAbsVector &	z = CLRelAbsVector(0.0, 0.0)
	)

Sets the coordinates for the second point.

References mFX, mFY, and mFZ.

Referenced by RadialGradientHandler::processStart(), and setCoordinates().

setRadius()

void CLRadialGradient::setRadius

(

const CLRelAbsVector &

r

)

Sets the radius.

References mRadius.

Referenced by RadialGradientHandler::processStart(), and setCoordinates().

toSBML()

RadialGradient * CLRadialGradient::toSBML ( unsigned int  level, unsigned int  version  ) const

virtual

Converts this object to the corresponding SBML object.

References CLGradientBase::addSBMLAttributes(), getCenterX(), getCenterY(), getCenterZ(), getFocalPointX(), getFocalPointY(), getFocalPointZ(), getRadius(), and CLRelAbsVector::toSBML().

Member Data Documentation

mCX

CLRelAbsVector CLRadialGradient::mCX

protected

Referenced by getCenterX(), and setCenter().

mCY

CLRelAbsVector CLRadialGradient::mCY

protected

Referenced by getCenterY(), and setCenter().

mCZ

CLRelAbsVector CLRadialGradient::mCZ

protected

Referenced by getCenterZ(), and setCenter().

mFX

CLRelAbsVector CLRadialGradient::mFX

protected

Referenced by getFocalPointX(), and setFocalPoint().

mFY

CLRelAbsVector CLRadialGradient::mFY

protected

Referenced by getFocalPointY(), and setFocalPoint().

mFZ

CLRelAbsVector CLRadialGradient::mFZ

protected

Referenced by getFocalPointZ(), and setFocalPoint().

mRadius

CLRelAbsVector CLRadialGradient::mRadius

protected

Referenced by getRadius(), and setRadius().

---

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

• CLRadialGradient.h
• CLRadialGradient.cpp