Inscoper::NBO::Shape_Type¶

Represents the XML complex type Shape. More...

#include <Shape_Type.h>

Inherits from NBOBaseClass

Inherited by Inscoper::NBO::Ellipse, Inscoper::NBO::Label, Inscoper::NBO::Line, Inscoper::NBO::Mask, Inscoper::NBO::Point, Inscoper::NBO::Polygon, Inscoper::NBO::Polyline, Inscoper::NBO::Rectangle

Public Functions¶

	Name
	Shape_Type()
	~Shape_Type()
virtual std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setFillColor(const Inscoper::NBO::Color_TypePtr & value, bool validate =true) Sets the value of the FillColor attribute.
Color_TypePtr	getFillColor() const Returns the value of the FillColor attribute.
void	resetFillColor() Resets the FillColor attribute to an unset state.
bool	hasFillColor() const Checks whether the optional FillColor attribute is present.
void	setFillRule(const std::string & value, bool validate =true) Sets the value of the FillRule attribute.
std::string	getFillRule() const Returns the value of the FillRule attribute.
void	resetFillRule() Resets the FillRule attribute to an unset state.
bool	hasFillRule() const Checks whether the FillRule attribute is present.
void	setStrokeColor(const Inscoper::NBO::Color_TypePtr & value, bool validate =true) Sets the value of the StrokeColor attribute.
Color_TypePtr	getStrokeColor() const Returns the value of the StrokeColor attribute.
void	resetStrokeColor() Resets the StrokeColor attribute to an unset state.
bool	hasStrokeColor() const Checks whether the optional StrokeColor attribute is present.
void	setStrokeWidth(const float & value, bool validate =true) Sets the value of the StrokeWidth attribute.
float	getStrokeWidth() const Returns the value of the StrokeWidth attribute.
void	resetStrokeWidth() Resets the StrokeWidth attribute to an unset state.
bool	hasStrokeWidth() const Checks whether the StrokeWidth attribute is present.
void	setStrokeWidthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the StrokeWidthUnit attribute.
UnitsLength_TypePtr	getStrokeWidthUnit() const Returns the value of the StrokeWidthUnit attribute.
void	resetStrokeWidthUnit() Resets the StrokeWidthUnit attribute to an unset state.
bool	hasStrokeWidthUnit() const Checks whether the optional StrokeWidthUnit attribute is present.
void	setStrokeDashArray(const std::string & value, bool validate =true) Sets the value of the StrokeDashArray attribute.
std::string	getStrokeDashArray() const Returns the value of the StrokeDashArray attribute.
void	resetStrokeDashArray() Resets the StrokeDashArray attribute to an unset state.
bool	hasStrokeDashArray() const Checks whether the StrokeDashArray attribute is present.
void	setText(const std::string & value, bool validate =true) Sets the value of the Text attribute.
std::string	getText() const Returns the value of the Text attribute.
void	resetText() Resets the Text attribute to an unset state.
bool	hasText() const Checks whether the Text attribute is present.
void	setFontFamily(const std::string & value, bool validate =true) Sets the value of the FontFamily attribute.
std::string	getFontFamily() const Returns the value of the FontFamily attribute.
void	resetFontFamily() Resets the FontFamily attribute to an unset state.
bool	hasFontFamily() const Checks whether the FontFamily attribute is present.
void	setFontSize(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the FontSize attribute.
NonNegativeInt_TypePtr	getFontSize() const Returns the value of the FontSize attribute.
void	resetFontSize() Resets the FontSize attribute to an unset state.
bool	hasFontSize() const Checks whether the optional FontSize attribute is present.
void	setFontSizeUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the FontSizeUnit attribute.
UnitsLength_TypePtr	getFontSizeUnit() const Returns the value of the FontSizeUnit attribute.
void	resetFontSizeUnit() Resets the FontSizeUnit attribute to an unset state.
bool	hasFontSizeUnit() const Checks whether the optional FontSizeUnit attribute is present.
void	setFontStyle(const std::string & value, bool validate =true) Sets the value of the FontStyle attribute.
std::string	getFontStyle() const Returns the value of the FontStyle attribute.
void	resetFontStyle() Resets the FontStyle attribute to an unset state.
bool	hasFontStyle() const Checks whether the FontStyle attribute is present.
void	setLocked(const bool & value, bool validate =true) Sets the value of the Locked attribute.
bool	getLocked() const Returns the value of the Locked attribute.
void	resetLocked() Resets the Locked attribute to an unset state.
bool	hasLocked() const Checks whether the Locked attribute is present.
void	setID(const Inscoper::NBO::ShapeID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ShapeID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setTheZ(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the TheZ attribute.
NonNegativeInt_TypePtr	getTheZ() const Returns the value of the TheZ attribute.
void	resetTheZ() Resets the TheZ attribute to an unset state.
bool	hasTheZ() const Checks whether the optional TheZ attribute is present.
void	setTheT(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the TheT attribute.
NonNegativeInt_TypePtr	getTheT() const Returns the value of the TheT attribute.
void	resetTheT() Resets the TheT attribute to an unset state.
bool	hasTheT() const Checks whether the optional TheT attribute is present.
void	setTheC(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the TheC attribute.
NonNegativeInt_TypePtr	getTheC() const Returns the value of the TheC attribute.
void	resetTheC() Resets the TheC attribute to an unset state.
bool	hasTheC() const Checks whether the optional TheC attribute is present.
void	setTransform(const Inscoper::NBO::AffineTransform_TypePtr & value, bool validate =true) Sets the value of the Transform element.
Inscoper::NBO::AffineTransform_TypePtr	getTransform() const Returns the value of the Transform element.
void	resetTransform() Resets the Transform element to an unset state.
bool	hasTransform() const Checks whether the optional Transform element is present.
void	setAnnotationRef_List(const std::vector< Inscoper::NBO::AnnotationRefPtr > & value, bool validate =true) Sets the list of AnnotationRef elements.
std::vector< Inscoper::NBO::AnnotationRefPtr >	getAnnotationRef_List() const Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
std::shared_ptr< Shape_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Shape_Type.
const std::set< std::string > &	getFillRuleAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getStrokeDashArrayAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getTextAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getFontFamilyAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getFontStyleAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Shape_Type;

Represents the XML complex type Shape.

The shape element contains a single specific ROI shape and links that to any channels, and a timepoint and a z-section. It also records any transform applied to the ROI shape.

Public Functions Documentation¶

function Shape_Type¶

function ~Shape_Type¶

function getTypeName¶

virtual std::string getTypeName() const override

Returns the class type name.

Return: The class type name

Reimplemented by: Inscoper::NBO::Ellipse::getTypeName, Inscoper::NBO::Label::getTypeName, Inscoper::NBO::Line::getTypeName, Inscoper::NBO::Mask::getTypeName, Inscoper::NBO::Point::getTypeName, Inscoper::NBO::Polygon::getTypeName, Inscoper::NBO::Polyline::getTypeName, Inscoper::NBO::Rectangle::getTypeName

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function setFillColor¶

void setFillColor(
    const Inscoper::NBO::Color_TypePtr & value,
    bool validate =true
)

Sets the value of the FillColor attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function getFillColor¶

Color_TypePtr getFillColor() const

Returns the value of the FillColor attribute.

Return: The value of the attribute

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function resetFillColor¶

void resetFillColor()

Resets the FillColor attribute to an unset state.

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function hasFillColor¶

bool hasFillColor() const

Checks whether the optional FillColor attribute is present.

Return: true if the optional attribute has been set, false otherwise

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function setFillRule¶

void setFillRule(
    const std::string & value,
    bool validate =true
)

Sets the value of the FillRule attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The rule used to decide which parts of the shape to fill. [enumeration]

function getFillRule¶

function resetFillRule¶

function hasFillRule¶

bool hasFillRule() const

Checks whether the FillRule attribute is present.

Return: true if the attribute has been set, false otherwise

The rule used to decide which parts of the shape to fill. [enumeration]

function setStrokeColor¶

void setStrokeColor(
    const Inscoper::NBO::Color_TypePtr & value,
    bool validate =true
)

Sets the value of the StrokeColor attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function getStrokeColor¶

Color_TypePtr getStrokeColor() const

Returns the value of the StrokeColor attribute.

Return: The value of the attribute

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function resetStrokeColor¶

void resetStrokeColor()

Resets the StrokeColor attribute to an unset state.

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function hasStrokeColor¶

bool hasStrokeColor() const

Checks whether the optional StrokeColor attribute is present.

Return: true if the optional attribute has been set, false otherwise

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function setStrokeWidth¶

void setStrokeWidth(
    const float & value,
    bool validate =true
)

Sets the value of the StrokeWidth attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The width of the stroke. Units are set by StrokeWidthUnit.

function getStrokeWidth¶

function resetStrokeWidth¶

function hasStrokeWidth¶

bool hasStrokeWidth() const

Checks whether the StrokeWidth attribute is present.

Return: true if the attribute has been set, false otherwise

The width of the stroke. Units are set by StrokeWidthUnit.

function setStrokeWidthUnit¶

void setStrokeWidthUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the StrokeWidthUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The units used for the stroke width.

function getStrokeWidthUnit¶

function resetStrokeWidthUnit¶

function hasStrokeWidthUnit¶

bool hasStrokeWidthUnit() const

Checks whether the optional StrokeWidthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

The units used for the stroke width.

function setStrokeDashArray¶

void setStrokeDashArray(
    const std::string & value,
    bool validate =true
)

Sets the value of the StrokeDashArray attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

e.g....................... "none", "10 20 30 10"

function getStrokeDashArray¶

function resetStrokeDashArray¶

function hasStrokeDashArray¶

bool hasStrokeDashArray() const

Checks whether the StrokeDashArray attribute is present.

Return: true if the attribute has been set, false otherwise

e.g....................... "none", "10 20 30 10"

function setText¶

void setText(
    const std::string & value,
    bool validate =true
)

Sets the value of the Text attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getText¶

function resetText¶

function hasText¶

function setFontFamily¶

void setFontFamily(
    const std::string & value,
    bool validate =true
)

Sets the value of the FontFamily attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function getFontFamily¶

std::string getFontFamily() const

Returns the value of the FontFamily attribute.

Return: The value of the attribute

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function resetFontFamily¶

void resetFontFamily()

Resets the FontFamily attribute to an unset state.

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function hasFontFamily¶

bool hasFontFamily() const

Checks whether the FontFamily attribute is present.

Return: true if the attribute has been set, false otherwise

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function setFontSize¶

void setFontSize(
    const Inscoper::NBO::NonNegativeInt_TypePtr & value,
    bool validate =true
)

Sets the value of the FontSize attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

Size of the font. Units are set by FontSizeUnit.

function getFontSize¶

function resetFontSize¶

function hasFontSize¶

bool hasFontSize() const

Checks whether the optional FontSize attribute is present.

Return: true if the optional attribute has been set, false otherwise

Size of the font. Units are set by FontSizeUnit.

function setFontSizeUnit¶

void setFontSizeUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the FontSizeUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The units used for the font size.

function getFontSizeUnit¶

function resetFontSizeUnit¶

function hasFontSizeUnit¶

function setFontStyle¶

void setFontStyle(
    const std::string & value,
    bool validate =true
)

Sets the value of the FontStyle attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function getFontStyle¶

std::string getFontStyle() const

Returns the value of the FontStyle attribute.

Return: The value of the attribute

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function resetFontStyle¶

void resetFontStyle()

Resets the FontStyle attribute to an unset state.

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function hasFontStyle¶

bool hasFontStyle() const

Checks whether the FontStyle attribute is present.

Return: true if the attribute has been set, false otherwise

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function setLocked¶

void setLocked(
    const bool & value,
    bool validate =true
)

Sets the value of the Locked attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

Controls whether the shape is locked and read only, true is locked, false is editable.

function getLocked¶

function resetLocked¶

function hasLocked¶

bool hasLocked() const

Checks whether the Locked attribute is present.

Return: true if the attribute has been set, false otherwise

Controls whether the shape is locked and read only, true is locked, false is editable.

function setID¶

void setID(
    const Inscoper::NBO::ShapeID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getID¶

function resetID¶

function hasID¶

function setTheZ¶

void setTheZ(
    const Inscoper::NBO::NonNegativeInt_TypePtr & value,
    bool validate =true
)

Sets the value of the TheZ attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getTheZ¶

function resetTheZ¶

function hasTheZ¶

function setTheT¶

void setTheT(
    const Inscoper::NBO::NonNegativeInt_TypePtr & value,
    bool validate =true
)

Sets the value of the TheT attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function getTheT¶

NonNegativeInt_TypePtr getTheT() const

Returns the value of the TheT attribute.

Return: The value of the attribute

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function resetTheT¶

void resetTheT()

Resets the TheT attribute to an unset state.

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function hasTheT¶

bool hasTheT() const

Checks whether the optional TheT attribute is present.

Return: true if the optional attribute has been set, false otherwise

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function setTheC¶

void setTheC(
    const Inscoper::NBO::NonNegativeInt_TypePtr & value,
    bool validate =true
)

Sets the value of the TheC attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function getTheC¶

NonNegativeInt_TypePtr getTheC() const

Returns the value of the TheC attribute.

Return: The value of the attribute

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function resetTheC¶

void resetTheC()

Resets the TheC attribute to an unset state.

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function hasTheC¶

bool hasTheC() const

Checks whether the optional TheC attribute is present.

Return: true if the optional attribute has been set, false otherwise

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function setTransform¶

void setTransform(
    const Inscoper::NBO::AffineTransform_TypePtr & value,
    bool validate =true
)

Sets the value of the Transform element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function getTransform¶

Inscoper::NBO::AffineTransform_TypePtr getTransform() const

Returns the value of the Transform element.

Return: The value of the element

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function resetTransform¶

void resetTransform()

Resets the Transform element to an unset state.

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function hasTransform¶

bool hasTransform() const

Checks whether the optional Transform element is present.

Return: true if the optional attribute has been set, false otherwise

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function setAnnotationRef_List¶

void setAnnotationRef_List(
    const std::vector< Inscoper::NBO::AnnotationRefPtr > & value,
    bool validate =true
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getAnnotationRef_List¶

std::vector< Inscoper::NBO::AnnotationRefPtr > getAnnotationRef_List() const

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

No description available in the XSD standard.

function addToAnnotationRef_List¶

void addToAnnotationRef_List(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function clearAnnotationRef_List¶

function fromBase¶

static std::shared_ptr< Shape_Type > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a Shape_Type.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getFillRuleAllowedValues¶

static const std::set< std::string > & getFillRuleAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The rule used to decide which parts of the shape to fill. [enumeration]

function getStrokeDashArrayAllowedValues¶

static const std::set< std::string > & getStrokeDashArrayAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

e.g....................... "none", "10 20 30 10"

function getTextAllowedValues¶

function getFontFamilyAllowedValues¶

static const std::set< std::string > & getFontFamilyAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function getFontStyleAllowedValues¶

static const std::set< std::string > & getFontStyleAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

Updated on 2026-09-23 at 16:50:39 +0200