Utilities

This group contains methods used to load, set up and display a GLG drawing. More...

Detailed Description

This group contains methods used to load, set up and display a GLG drawing.

Functions
	GlgObjectC (GlgObject object)
	Constructor: Creates a C++ class from GlgObject. More...
	GlgObjectC (void)
	Default constructor: Creates a null object. More...
virtual	~GlgObjectC (void)
	Destructor: Destroys an instance of GlgObjectC and dereferences the GlgObject object it contains. More...
void	Drop (void)
	Explicitly dereferences the GLG object contained in this instance. More...
GlgObject	GetGlgObject (void)
	Returns an object ID of the stored GlgObject object. More...
GlgBoolean	IsNull (void)
	Checks if a non-null object is stored in this instance. More...
	operator GlgObject (void)
	Type converter to GlgObject. More...
GlgBoolean	operator! (void)
	Checks if a non-null object is stored in this instance. More...
GlgObjectC &	operator++ (int)
	Postfix operator: References an object. More...
GlgObjectC &	operator++ (void)
	Prefix operator: References an object. More...
GlgObjectC &	operator-- (int)
	Postfix operator: Dereferences an object. More...
GlgObjectC &	operator-- (void)
	Prefix operator: Dereferences an object. More...
GlgObjectC &	operator= (const GlgObjectC &object)
	Assignment operator: Stores a GLG object in this instance. More...
void	Reference (void)
	Explicitly references the GLG object contained in this instance. More...
GlgBoolean	Same (GlgObject object)
	Compares two GLG objects. More...
GlgBoolean	Same (GlgObjectC &object)
	Compares two GLG objects. More...
void	SetGlgObject (GlgObject object)
	Low-level utility: Stores the specified GlgObject object in this object and references the stored object. More...

Function Documentation

GlgObjectC() [1/2]

GlgObjectC

(

GlgObject

object

)

Constructor: Creates a C++ class from GlgObject.

This constructor makes it possible to assign GlgObject to a GlgObjectC object class:

GlgObjectC object = GetResourceObject( ... );

Parameters

object

C API object of the GlgObject type.

GlgObjectC() [2/2]

GlgObjectC

(

void

)

Default constructor: Creates a null object.

~GlgObjectC()

virtual ~GlgObjectC ( void  )

virtual

Destructor: Destroys an instance of GlgObjectC and dereferences the GlgObject object it contains.

Drop()

void Drop

(

void

)

Explicitly dereferences the GLG object contained in this instance.

This is a wrapper for GlgDropObject.

GetGlgObject()

GlgObject GetGlgObject

(

void

)

Returns an object ID of the stored GlgObject object.

Returns

A stored GlgObject ID, or NULL if no object is stored.

IsNull()

GlgBoolean IsNull

(

void

)

Checks if a non-null object is stored in this instance.

Returns

True if this instance contains a GLG object.

operator GlgObject()

operator GlgObject

(

void

)

Type converter to GlgObject.

This type converter allows using C++ GlgObjectC object instances as the GlgObject parameters of the C API functions.

operator!()

GlgBoolean operator!

(

void

)

Checks if a non-null object is stored in this instance.

Returns

True if this instance contains a GLG object.

operator++() [1/2]

GlgObjectC& operator++

(

int

)

Postfix operator: References an object.

This is a wrapper for GlgReferenceObject.

Returns

A pointer to this object.

operator++() [2/2]

GlgObjectC& operator++

(

void

)

Prefix operator: References an object.

This is a wrapper for GlgReferenceObject.

Returns

A pointer to this object.

operator--() [1/2]

GlgObjectC& operator--

(

int

)

Postfix operator: Dereferences an object.

This is a wrapper for GlgDropObject.

Returns

A pointer to this object.

operator--() [2/2]

GlgObjectC& operator--

(

void

)

Prefix operator: Dereferences an object.

This is a wrapper for GlgDropObject.

Returns

A pointer to this object.

operator=()

GlgObjectC& operator=

(

const GlgObjectC &

object

)

Assignment operator: Stores a GLG object in this instance.

Parameters

object

The object to store.

Returns

A pointer to this object.

Reference()

void Reference

(

void

)

Explicitly references the GLG object contained in this instance.

This is a wrapper for GlgReferenceObject.

Same() [1/2]

GlgBoolean Same

(

GlgObject

object

)

Compares two GLG objects.

Parameters

object

The object to compare with.

Returns

True if this object refers to the same GLG object as the object parameter

Same() [2/2]

GlgBoolean Same

(

GlgObjectC &

object

)

Compares two GLG objects.

Parameters

object

The object to compare with.

Returns

True if this object refers to the same GLG object as the object parameter

SetGlgObject()

void SetGlgObject

(

GlgObject

object

)

Low-level utility: Stores the specified GlgObject object in this object and references the stored object.

Parameters

object

The object to store.