#include <CLLinearGradient.h>

Inheritance diagram for CLLinearGradient:

Public Member Functions
	CLLinearGradient (CDataContainer *pParent=NULL)

	CLLinearGradient (const CLLinearGradient &source, CDataContainer *pParent=NULL)

	CLLinearGradient (const LinearGradient &source, CDataContainer *pParent=NULL)

CLRelAbsVector &	getXPoint1 ()

const CLRelAbsVector &	getXPoint1 () const

CLRelAbsVector &	getXPoint2 ()

const CLRelAbsVector &	getXPoint2 () const

CLRelAbsVector &	getYPoint1 ()

const CLRelAbsVector &	getYPoint1 () const

CLRelAbsVector &	getYPoint2 ()

const CLRelAbsVector &	getYPoint2 () const

CLRelAbsVector &	getZPoint1 ()

const CLRelAbsVector &	getZPoint1 () const

CLRelAbsVector &	getZPoint2 ()

const CLRelAbsVector &	getZPoint2 () const

void	setCoordinates (const CLRelAbsVector &x1, const CLRelAbsVector &y1, const CLRelAbsVector &x2, const CLRelAbsVector &y2)

void	setCoordinates (const CLRelAbsVector &x1, const CLRelAbsVector &y1, const CLRelAbsVector &z1, const CLRelAbsVector &x2, const CLRelAbsVector &y2, const CLRelAbsVector &z2)

void	setPoint1 (const CLRelAbsVector &x1, const CLRelAbsVector &y1, const CLRelAbsVector &z1=CLRelAbsVector(0.0, 0.0))

void	setPoint2 (const CLRelAbsVector &x1, const CLRelAbsVector &y1, const CLRelAbsVector &z1=CLRelAbsVector(0.0, 0.0))

virtual LinearGradient *	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	mX1

CLRelAbsVector	mX2

CLRelAbsVector	mY1

CLRelAbsVector	mY2

CLRelAbsVector	mZ1

CLRelAbsVector	mZ2

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
CLLinearGradient &	operator= (const CLLinearGradient &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

◆ CLLinearGradient() [1/3]

CLLinearGradient::CLLinearGradient ( CDataContainer * pParent = NULL )

Constructor.

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

◆ CLLinearGradient() [2/3]

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

Copy Constructor

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

◆ CLLinearGradient() [3/3]

CLLinearGradient::CLLinearGradient	(	const LinearGradient &	source,
		CDataContainer *	pParent = `NULL`
	)

Constructor to generate object from the corresponding SBML object.

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

Member Function Documentation

◆ getXPoint1() [1/2]

CLRelAbsVector & CLLinearGradient::getXPoint1 ( )

Returns the x coordinate for the first point.

References mX1.

◆ getXPoint1() [2/2]

const CLRelAbsVector & CLLinearGradient::getXPoint1 ( ) const

Returns the x coordinate for the first point.

References mX1.

Referenced by CLLayoutRenderer::create_linear_gradient_texture(), CCopasiXML::saveLinearGradient(), and toSBML().

◆ getXPoint2() [1/2]

CLRelAbsVector & CLLinearGradient::getXPoint2 ( )

Returns the x coordinate for the second point.

References mX2.

◆ getXPoint2() [2/2]

const CLRelAbsVector & CLLinearGradient::getXPoint2 ( ) const

Returns the x coordinate for the second point.

References mX2.

Referenced by CLLayoutRenderer::create_linear_gradient_texture(), CCopasiXML::saveLinearGradient(), and toSBML().

◆ getYPoint1() [1/2]

CLRelAbsVector & CLLinearGradient::getYPoint1 ( )

Returns the y coordinate for the first point.

Returns the x coordinate for the first point.

References mY1.

◆ getYPoint1() [2/2]

const CLRelAbsVector & CLLinearGradient::getYPoint1 ( ) const

Returns the y coordinate for the first point.

Returns the x coordinate for the first point.

References mY1.

Referenced by CLLayoutRenderer::create_linear_gradient_texture(), CCopasiXML::saveLinearGradient(), and toSBML().

◆ getYPoint2() [1/2]

CLRelAbsVector & CLLinearGradient::getYPoint2 ( )

Returns the y coordinate for the second point.

Returns the x coordinate for the second point.

References mY2.

◆ getYPoint2() [2/2]

const CLRelAbsVector & CLLinearGradient::getYPoint2 ( ) const

Returns the y coordinate for the second point.

Returns the x coordinate for the second point.

References mY2.

Referenced by CLLayoutRenderer::create_linear_gradient_texture(), CCopasiXML::saveLinearGradient(), and toSBML().

◆ getZPoint1() [1/2]

CLRelAbsVector & CLLinearGradient::getZPoint1 ( )

Returns the z coordinate for the first point.

Returns the x coordinate for the first point.

References mZ1.

◆ getZPoint1() [2/2]

const CLRelAbsVector & CLLinearGradient::getZPoint1 ( ) const

Returns the z coordinate for the first point.

Returns the x coordinate for the first point.

References mZ1.

Referenced by CLLayoutRenderer::create_linear_gradient_texture(), CCopasiXML::saveLinearGradient(), and toSBML().

◆ getZPoint2() [1/2]

CLRelAbsVector & CLLinearGradient::getZPoint2 ( )

Returns the z coordinate for the second point.

Returns the x coordinate for the second point.

References mZ2.

◆ getZPoint2() [2/2]

const CLRelAbsVector & CLLinearGradient::getZPoint2 ( ) const

Returns the z coordinate for the second point.

Returns the x coordinate for the second point.

References mZ2.

Referenced by CLLayoutRenderer::create_linear_gradient_texture(), CCopasiXML::saveLinearGradient(), and toSBML().

◆ operator=()

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

private

◆ setCoordinates() [1/2]

void CLLinearGradient::setCoordinates	(	const CLRelAbsVector &	x1,
		const CLRelAbsVector &	y1,
		const CLRelAbsVector &	x2,
		const CLRelAbsVector &	y2
	)

Sets the 3D coordinates for both points.

References setCoordinates().

◆ setCoordinates() [2/2]

void CLLinearGradient::setCoordinates	(	const CLRelAbsVector &	x1,
		const CLRelAbsVector &	y1,
		const CLRelAbsVector &	z1,
		const CLRelAbsVector &	x2,
		const CLRelAbsVector &	y2,
		const CLRelAbsVector &	z2
	)

Sets the 3D coordinates for both points.

References setPoint1(), and setPoint2().

Referenced by setCoordinates().

◆ setPoint1()

void CLLinearGradient::setPoint1	(	const CLRelAbsVector &	x,
		const CLRelAbsVector &	y,
		const CLRelAbsVector &	z = `CLRelAbsVector(0.0, 0.0)`
	)

Sets the coordinates for the first point.

References mX1, mY1, and mZ1.

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

◆ setPoint2()

void CLLinearGradient::setPoint2	(	const CLRelAbsVector &	x,
		const CLRelAbsVector &	y,
		const CLRelAbsVector &	z = `CLRelAbsVector(0.0, 0.0)`
	)

Sets the coordinates for the second point.

References mX2, mY2, and mZ2.

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

◆ toSBML()

LinearGradient * CLLinearGradient::toSBML	(	unsigned int	level,
		unsigned int	version
	)		const

virtual

Converts this object to the corresponding SBML object.

References CLGradientBase::addSBMLAttributes(), getXPoint1(), getXPoint2(), getYPoint1(), getYPoint2(), getZPoint1(), getZPoint2(), and CLRelAbsVector::toSBML().

Member Data Documentation

◆ mX1

CLRelAbsVector CLLinearGradient::mX1

protected

Referenced by getXPoint1(), and setPoint1().

◆ mX2

CLRelAbsVector CLLinearGradient::mX2

protected

Referenced by getXPoint2(), and setPoint2().

◆ mY1

CLRelAbsVector CLLinearGradient::mY1

protected

Referenced by getYPoint1(), and setPoint1().

◆ mY2

CLRelAbsVector CLLinearGradient::mY2

protected

Referenced by getYPoint2(), and setPoint2().

◆ mZ1

CLRelAbsVector CLLinearGradient::mZ1

protected

Referenced by getZPoint1(), and setPoint1().

◆ mZ2

CLRelAbsVector CLLinearGradient::mZ2

protected

Referenced by getZPoint2(), and setPoint2().

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

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ CLLinearGradient() [1/3]

◆ CLLinearGradient() [2/3]

◆ CLLinearGradient() [3/3]

Member Function Documentation

◆ getXPoint1() [1/2]

◆ getXPoint1() [2/2]

◆ getXPoint2() [1/2]

◆ getXPoint2() [2/2]

◆ getYPoint1() [1/2]

◆ getYPoint1() [2/2]

◆ getYPoint2() [1/2]

◆ getYPoint2() [2/2]

◆ getZPoint1() [1/2]

◆ getZPoint1() [2/2]

◆ getZPoint2() [1/2]

◆ getZPoint2() [2/2]

◆ operator=()

◆ setCoordinates() [1/2]

◆ setCoordinates() [2/2]

◆ setPoint1()

◆ setPoint2()

◆ toSBML()

Member Data Documentation

◆ mX1

◆ mX2

◆ mY1

◆ mY2

◆ mZ1

◆ mZ2