EdgeExport Class Reference

Stores edge exporting values. More...

Public Member Functions
	EdgeExport ()
	Creates a new instance.
virtual	~EdgeExport ()
	Destructor.
void	SetDefaults ()
	Sets to default values.
const std::wstring &	GetLabel () const
	Gets the edge label. More...
void	SetLabel (const std::wstring &label)
	Sets the edge label. More...
bool_t	AsDirected () const
	Gets if the edge should be managed as directed. More...
void	SetAsDirected (bool_t directed)
	Sets if the edge should be managed as directed. More...
ColorRGB	GetColorRGB () const
	Gets the edge color. More...
void	SetColorRGB (ColorRGB color)
	Sets the edge color. More...
ColorRGB	GetLabelColorRGB () const
	Gets the edge label color. More...
void	SetLabelColorRGB (ColorRGB color)
	Sets the edge label color. More...
int32_t	GetWidth () const
	Gets the edge width. More...
void	SetWidth (int32_t width)
	Sets the edge width. More...
int32_t	GetFontSize () const
	Gets the edge label font size. More...
void	SetFontSize (int32_t size)
	Sets the edge label font size. More...

Detailed Description

Stores edge exporting values.

Some properties may be ignored depending on the exportation type.

Default values are:

Label: "" (empty string).

As directed: TRUE.

Color: 13882323 (OxD3D3D3, Light gray).

Label color: 0 (Ox000000, Black).

Width: 5px.

Font size: 10.

Author

Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

bool_t EdgeExport::AsDirected ( ) const

inline

Gets if the edge should be managed as directed.

TRUE is the default value. If TRUE, use as directed, otherwise use as undirected.

Returns

The edge direction.

ColorRGB EdgeExport::GetColorRGB ( ) const

inline

Gets the edge color.

Returns

The edge color.

int32_t EdgeExport::GetFontSize ( ) const

inline

Gets the edge label font size.

Returns

The edge label font size.

const std::wstring& EdgeExport::GetLabel ( ) const

inline

Gets the edge label.

Returns

The edge label.

ColorRGB EdgeExport::GetLabelColorRGB ( ) const

inline

Gets the edge label color.

Returns

The edge label color.

int32_t EdgeExport::GetWidth ( ) const

inline

Gets the edge width.

Returns

The edge width.

void EdgeExport::SetAsDirected ( bool_t  directed )

inline

Sets if the edge should be managed as directed.

Parameters

directed

[in] If TRUE, use as directed, otherwise use as undirected.

void EdgeExport::SetColorRGB ( ColorRGB  color )

inline

Sets the edge color.

Parameters

color

[in] The edge color.

void EdgeExport::SetFontSize ( int32_t  size )

inline

Sets the edge label font size.

Parameters

size	[in] The edge label font size.

void EdgeExport::SetLabel ( const std::wstring &  label )

inline

Sets the edge label.

Parameters

label

[in] The edge label.

void EdgeExport::SetLabelColorRGB ( ColorRGB  color )

inline

Sets the edge label color.

Parameters

color

[in] The edge label color.

void EdgeExport::SetWidth ( int32_t  width )

inline

Sets the edge width.

Parameters

width

[in] The edge width.

---

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

• Export.h