API for the attribute that contains binary data. More...

Inheritance diagram for ModelAPI_AttributeImage:

Public Member Functions
virtual MODELAPI_EXPORT void	setTexture (const int theWidth, const int theHeight, const std::list< unsigned char > &theByteArray, const std::string &theFormat, const bool sendUpdated=true)=0
	Defines the value of the image attribute. More...

virtual MODELAPI_EXPORT bool	hasTexture ()=0
	Returns true, if texture width and height are non-zero. More...

virtual MODELAPI_EXPORT bool	texture (int &theWidth, int &theHeight, std::list< unsigned char > &theByteArray, std::string &theFormat)=0
	Returns the value of the image attribute. More...

virtual void	copyTo (std::shared_ptr< ModelAPI_AttributeImage > theTarget) const =0
	Copy the image data to the destination attribute. More...

virtual MODELAPI_EXPORT std::string	attributeType ()
	Returns the type of this class of attributes, not static method. More...

virtual MODELAPI_EXPORT	~ModelAPI_AttributeImage ()
	To virtually destroy the fields of successors. More...

virtual void	setObject (const std::shared_ptr< ModelAPI_Object > &theObject)
	Sets the owner of this attribute. More...

const std::shared_ptr< ModelAPI_Object > &	owner () const
	Returns the owner of this attribute. More...

virtual bool	isInitialized ()
	Returns true if attribute was initialized by some value. More...

void	setInitialized ()
	Makes attribute initialized. More...

bool	blockSetInitialized (const bool theBlock)
	Blocks sending "attribute updated" if theBlock is true. More...

void	setIsArgument (const bool theFlag)
	Set this attribute is argument for result (change of this attribute requires update of result). More...

bool	isArgument ()
	Returns true if attribute causes the result change. More...

bool	setImmutable (const bool theFlag)
	Immutable argument can not be changed programmatically (e.g. More...

bool	isImmutable ()
	Returns true if can not be changed programmatically. More...

const std::string &	id () const
	ID of the attribute in Data. More...

virtual void	reset ()
	Resets attribute to default state. More...

Static Public Member Functions
static MODELAPI_EXPORT std::string	typeId ()
	Returns the type of this class of attributes. More...

Protected Member Functions
MODELAPI_EXPORT	ModelAPI_AttributeImage ()
	Objects are created for features automatically. More...

virtual void	setID (const std::string theID)
	Sets the ID of the attribute in Data (called from Data) More...

virtual void	reinit ()
	Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc) More...

Protected Attributes
bool	myIsInitialized
	is some value assigned to this attribute More...

bool	mySetInitializedBlocked
	is initialized blocked More...

bool	myIsArgument
	is this attribute used as an argument for execution More...

bool	myIsImmutable
	is this attribute can be changed programmatically (e.g. by constraint) More...

Detailed Description

API for the attribute that contains binary data.

Used for images storage for an example. By default size is one, zero-based.

Constructor & Destructor Documentation

◆ ~ModelAPI_AttributeImage()

ModelAPI_AttributeImage::~ModelAPI_AttributeImage ( )

virtual

To virtually destroy the fields of successors.

◆ ModelAPI_AttributeImage()

ModelAPI_AttributeImage::ModelAPI_AttributeImage ( )

protected

Objects are created for features automatically.

Member Function Documentation

◆ setTexture()

virtual MODELAPI_EXPORT void ModelAPI_AttributeImage::setTexture	(	const int	theWidth,
		const int	theHeight,
		const std::list< unsigned char > &	theByteArray,
		const std::string &	theFormat,
		const bool	sendUpdated = `true`
	)

pure virtual

Defines the value of the image attribute.

Implemented in Model_AttributeImage.

◆ hasTexture()

virtual MODELAPI_EXPORT bool ModelAPI_AttributeImage::hasTexture ( )

pure virtual

Returns true, if texture width and height are non-zero.

Implemented in Model_AttributeImage.

◆ texture()

virtual MODELAPI_EXPORT bool ModelAPI_AttributeImage::texture	(	int &	theWidth,
		int &	theHeight,
		std::list< unsigned char > &	theByteArray,
		std::string &	theFormat
	)

pure virtual

Returns the value of the image attribute.

Implemented in Model_AttributeImage.

◆ copyTo()

virtual void ModelAPI_AttributeImage::copyTo ( std::shared_ptr< ModelAPI_AttributeImage > theTarget ) const

pure virtual

Copy the image data to the destination attribute.

Implemented in Model_AttributeImage.

◆ typeId()

static MODELAPI_EXPORT std::string ModelAPI_AttributeImage::typeId ( )

inlinestatic

Returns the type of this class of attributes.

◆ attributeType()

std::string ModelAPI_AttributeImage::attributeType ( )

virtual

Returns the type of this class of attributes, not static method.

Implements ModelAPI_Attribute.

◆ setObject()

void ModelAPI_Attribute::setObject ( const std::shared_ptr< ModelAPI_Object > & theObject )

virtualinherited

Sets the owner of this attribute.

Reimplemented in Model_AttributeSelection, and Model_AttributeReference.

◆ owner()

const std::shared_ptr< ModelAPI_Object > & ModelAPI_Attribute::owner ( ) const

inherited

Returns the owner of this attribute.

◆ isInitialized()

bool ModelAPI_Attribute::isInitialized ( )

virtualinherited

Returns true if attribute was initialized by some value.

Reimplemented in Model_AttributeSelectionList, Model_AttributeSelection, Model_AttributeRefList, Model_AttributeReference, Model_AttributeRefAttrList, Model_AttributeRefAttr, and GeomData_Dir.

◆ setInitialized()

void ModelAPI_Attribute::setInitialized ( )

inherited

Makes attribute initialized.

◆ blockSetInitialized()

bool ModelAPI_Attribute::blockSetInitialized ( const bool theBlock )

inherited

Blocks sending "attribute updated" if theBlock is true.

Parameters

theBlock a block value

Returns: the previous block value

◆ setIsArgument()

void ModelAPI_Attribute::setIsArgument ( const bool theFlag )

inherited

Set this attribute is argument for result (change of this attribute requires update of result).

By default it is true.

◆ isArgument()

bool ModelAPI_Attribute::isArgument ( )

inherited

Returns true if attribute causes the result change.

◆ setImmutable()

bool ModelAPI_Attribute::setImmutable ( const bool theFlag )

inherited

Immutable argument can not be changed programmatically (e.g.

by constraint) By default it is false. Returns the previous state of the attribute's immutability.

◆ isImmutable()

bool ModelAPI_Attribute::isImmutable ( )

inherited

Returns true if can not be changed programmatically.

◆ id()

const std::string & ModelAPI_Attribute::id ( ) const

inherited

ID of the attribute in Data.

◆ reset()

void ModelAPI_Attribute::reset ( )

virtualinherited

Resets attribute to default state.

Reimplemented in Model_AttributeSelection, Model_AttributeDouble, GeomData_Point2D, and GeomData_Dir.

◆ setID()

void ModelAPI_Attribute::setID ( const std::string theID )

protectedvirtualinherited

Sets the ID of the attribute in Data (called from Data)

Reimplemented in Model_AttributeSelection.

◆ reinit()

void ModelAPI_Attribute::reinit ( )

protectedvirtualinherited

Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)

Reimplemented in Model_AttributeTables, Model_AttributeString, Model_AttributeSelectionList, Model_AttributeRefList, Model_AttributeReference, Model_AttributeRefAttrList, Model_AttributeRefAttr, Model_AttributeInteger, Model_AttributeIntArray, Model_AttributeImage, Model_AttributeDoubleArray, Model_AttributeDouble, Model_AttributeDocRef, Model_AttributeBoolean, GeomData_Point2DArray, GeomData_Point2D, GeomData_Point, and GeomData_Dir.

Field Documentation

◆ myIsInitialized

bool ModelAPI_Attribute::myIsInitialized

protectedinherited

is some value assigned to this attribute

◆ mySetInitializedBlocked

bool ModelAPI_Attribute::mySetInitializedBlocked

protectedinherited

is initialized blocked

◆ myIsArgument

bool ModelAPI_Attribute::myIsArgument

protectedinherited

is this attribute used as an argument for execution

◆ myIsImmutable

bool ModelAPI_Attribute::myIsImmutable

protectedinherited

is this attribute can be changed programmatically (e.g. by constraint)

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~ModelAPI_AttributeImage()

◆ ModelAPI_AttributeImage()

Member Function Documentation

◆ setTexture()

◆ hasTexture()

◆ texture()

◆ copyTo()

◆ typeId()

◆ attributeType()

◆ setObject()

◆ owner()

◆ isInitialized()

◆ setInitialized()

◆ blockSetInitialized()

◆ setIsArgument()

◆ isArgument()

◆ setImmutable()

◆ isImmutable()

◆ id()

◆ reset()

◆ setID()

◆ reinit()

Field Documentation

◆ myIsInitialized

◆ mySetInitializedBlocked

◆ myIsArgument

◆ myIsImmutable