SHAPER  9.12.0
Model_AttributeImage Class Reference

API for the attribute that contains image inside. More...

Inheritance diagram for Model_AttributeImage:
Inheritance graph

Public Member Functions

virtual MODEL_EXPORT void setTexture (const int theWidth, const int theHeight, const std::list< unsigned char > &theByteArray, const std::string &theFormat, const bool sendUpdated=true)
 Defines the value of the image attribute. More...
 
virtual MODEL_EXPORT bool hasTexture ()
 Returns true, if texture width and height are non-zero. More...
 
virtual MODEL_EXPORT bool texture (int &theWidth, int &theHeight, std::list< unsigned char > &theByteArray, std::string &theFormat)
 Returns the value of the image attribute. More...
 
virtual void copyTo (std::shared_ptr< ModelAPI_AttributeImage > theTarget) const
 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 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 deafult state. More...
 

Static Public Member Functions

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

Protected Member Functions

 Model_AttributeImage (TDF_Label &theLabel)
 Initializes attibutes. More...
 
virtual void reinit ()
 Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc) More...
 
virtual void setID (const std::string theID)
 Sets the ID of the attribute in Data (called from Data) 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...
 

Friends

class Model_Data
 

Detailed Description

API for the attribute that contains image inside.

Represented as the following OCCT attributes: TDataStd_ByteArray for the pixmap texture data, TDataStd_IntArray(2) for image dimensions (widht and height), TDataStd_String for image format.

Constructor & Destructor Documentation

◆ Model_AttributeImage()

Model_AttributeImage::Model_AttributeImage ( TDF_Label &  theLabel)
protected

Initializes attibutes.

Member Function Documentation

◆ setTexture()

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

Defines the value of the image attribute.

Implements ModelAPI_AttributeImage.

◆ hasTexture()

bool Model_AttributeImage::hasTexture ( )
virtual

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

Implements ModelAPI_AttributeImage.

◆ texture()

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

Returns the value of the image attribute.

Implements ModelAPI_AttributeImage.

◆ copyTo()

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

Copy the image data to the destination attribute.

Implements ModelAPI_AttributeImage.

◆ reinit()

void Model_AttributeImage::reinit ( )
protectedvirtual

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

Reimplemented from ModelAPI_Attribute.

◆ typeId()

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

Returns the type of this class of attributes.

◆ attributeType()

std::string ModelAPI_AttributeImage::attributeType ( )
virtualinherited

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

◆ 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
theBlocka 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 deafult 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.

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)