Aspect_WidthMapEntry Class Reference

This class defines a widthmap entry.
A widthmap entry is an association between
a LineStyle object and an index in the widthmap.
More...

#include <Aspect_WidthMapEntry.hxx>

Public Member Functions
	Aspect_WidthMapEntry ()
	Creates an unallocated widthmap entry More...
	Aspect_WidthMapEntry (const Standard_Integer index, const Aspect_WidthOfLine style)
	Creates an allocated widthmap entry from width style More...
	Aspect_WidthMapEntry (const Standard_Integer index, const Quantity_Length width)
	Creates an allocated widthmap entry from width value More...
	Aspect_WidthMapEntry (const Aspect_WidthMapEntry &entry)
	Creates an allocated widthmap entry. More...
void	SetValue (const Standard_Integer index, const Aspect_WidthOfLine style)
	Sets widthmap entry value from width style and allocates it. More...
void	SetValue (const Standard_Integer index, const Quantity_Length width)
	Sets widthmap entry value from width value and allocates it. More...
void	SetValue (const Aspect_WidthMapEntry &entry)
	Sets widthmap entry value and allocates it. More...
void	operator= (const Aspect_WidthMapEntry &entry)
void	SetIndex (const Standard_Integer index)
	Sets index value of a widthmap entry. More...
void	SetType (const Aspect_WidthOfLine Style)
	Sets width style of widthmap entry. More...
void	SetWidth (const Quantity_Length Width)
	Sets width value of widthmap entry. More...
Aspect_WidthOfLine	Type () const
Quantity_Length	Width () const
	Returns width value of widthmap entry. <br> Warning: Raises error if the widthmap entry is unallocated . More...
Standard_Integer	Index () const
	Returns index value of a widthmap entry. <br> Warning: Raises error if the widthmap entry is unallocated . More...
void	Free ()
	Unallocates the widthmap entry. More...
Standard_Boolean	IsAllocated () const
	Returns True if the widthmap entry is allocated. <br> Warning: A widthmap entry is allocated when the width and the index is defined. More...
void	Dump () const

Detailed Description

This class defines a widthmap entry.
A widthmap entry is an association between
a LineStyle object and an index in the widthmap.

Constructor & Destructor Documentation

Aspect_WidthMapEntry::Aspect_WidthMapEntry

(

)

Creates an unallocated widthmap entry

Aspect_WidthMapEntry::Aspect_WidthMapEntry	(	const Standard_Integer	index,
		const Aspect_WidthOfLine	style
	)

Creates an allocated widthmap entry from width style

Aspect_WidthMapEntry::Aspect_WidthMapEntry	(	const Standard_Integer	index,
		const Quantity_Length	width
	)

Creates an allocated widthmap entry from width value

Aspect_WidthMapEntry::Aspect_WidthMapEntry

(

const Aspect_WidthMapEntry &

entry

)

Creates an allocated widthmap entry.

Member Function Documentation

void Aspect_WidthMapEntry::Dump

(

)

const

void Aspect_WidthMapEntry::Free

(

)

Unallocates the widthmap entry.

Standard_Integer Aspect_WidthMapEntry::Index

(

)

const

Returns index value of a widthmap entry. <br>

Warning: Raises error if the widthmap entry is unallocated .

Standard_Boolean Aspect_WidthMapEntry::IsAllocated

(

)

const

Returns True if the widthmap entry is allocated. <br>

Warning: A widthmap entry is allocated when the width and
the index is defined.

void Aspect_WidthMapEntry::operator= ( const Aspect_WidthMapEntry &  entry )

inline

void Aspect_WidthMapEntry::SetIndex

(

const Standard_Integer

index

)

Sets index value of a widthmap entry.

void Aspect_WidthMapEntry::SetType

(

const Aspect_WidthOfLine

Style

)

Sets width style of widthmap entry.

void Aspect_WidthMapEntry::SetValue	(	const Standard_Integer	index,
		const Aspect_WidthOfLine	style
	)

Sets widthmap entry value from width style
and allocates it.

void Aspect_WidthMapEntry::SetValue	(	const Standard_Integer	index,
		const Quantity_Length	width
	)

Sets widthmap entry value from width value
and allocates it.

void Aspect_WidthMapEntry::SetValue

(

const Aspect_WidthMapEntry &

entry

)

Sets widthmap entry value and allocates it.

void Aspect_WidthMapEntry::SetWidth

(

const Quantity_Length

Width

)

Sets width value of widthmap entry.

Aspect_WidthOfLine Aspect_WidthMapEntry::Type

(

)

const

Quantity_Length Aspect_WidthMapEntry::Width

(

)

const

Returns width value of widthmap entry. <br>

Warning: Raises error if the widthmap entry is unallocated .

---

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

• Aspect_WidthMapEntry.hxx