Extended API Methods

Detailed Description

Functions
virtual bool	AddObjectAt (GlgObject container, Object object, int index)
	Adds an object at the specified position inside the container. More...
virtual bool	AddObjectToBottom (GlgObject container, Object object)
	Adds an object at the end of the container. More...
virtual bool	AddObjectToTop (GlgObject container, Object object)
	Adds an object at the end of the container. More...
virtual GlgObject	CloneObject (GlgObject glg_object, GlgCloneType clone_type)
	Creates a specialized copy (clone) of an object. More...
virtual GlgObject	CopyObject (GlgObject glg_object)
	Creates a copy of the object. More...
virtual bool	DeleteBottomObject (GlgObject container)
	Deletes an object from the bottom of the container. More...
virtual bool	DeleteObject (GlgObject container, Object object)
	Finds and deletes an object from the container. More...
virtual bool	DeleteObjectAt (GlgObject container, int index)
	Deletes an object from the specified position in the container. More...
virtual bool	DeleteTopObject (GlgObject container)
	Deletes an object from the beginning of the container. More...
virtual bool	SetResourceObject (GlgObject glg_object, String resource_name, GlgObject value)
	Replaces a resource object inside the object the method is invoked on. More...
virtual bool	SetXform (GlgObject glg_object, GlgObject xform)
	Adds or deletes transformations attached to the object. More...

Function Documentation

AddObjectAt()

virtual bool AddObjectAt ( GlgObject  container, Object  object, int  index  )

virtual

Adds an object at the specified position inside the container.

Parameters

container	A container object.
object	The object to be added.
index	The position in a container.

Returns

Success or failure status.

This method invokes the corresponding method of the GlgObject class. See AddObjectAt for more information.

AddObjectToBottom()

virtual bool AddObjectToBottom ( GlgObject  container, Object  object  )

virtual

Adds an object at the end of the container.

Parameters

container	A container object.
object	The object to be added.

Returns

Success or failure status.

This method invokes the corresponding method of the GlgObject class. See AddObjectToBottom for more information.

AddObjectToTop()

virtual bool AddObjectToTop ( GlgObject  container, Object  object  )

virtual

Adds an object at the end of the container.

Parameters

container	A container object.
object	The object to be added.

Returns

Success or failure status.

This method invokes the corresponding method of the GlgObject class. See AddObjectToTop for more information.

CloneObject()

virtual GlgObject CloneObject ( GlgObject  glg_object, GlgCloneType  clone_type  )

virtual

Creates a specialized copy (clone) of an object.

Parameters

clone_type	The type of cloning to perform, see CloneObject.
glg_object	The object to be copied.

Returns

An object's clone.

This method invokes the corresponding method of the GlgObject class. See CloneObject for more information.

CopyObject()

virtual GlgObject CopyObject ( GlgObject  glg_object )

virtual

Creates a copy of the object.

Parameters

glg_object

The object to be copied.

Returns

An object's copy.

This method invokes the corresponding method of the GlgObject class. See CopyObject for more information.

DeleteBottomObject()

virtual bool DeleteBottomObject ( GlgObject  container )

virtual

Deletes an object from the bottom of the container.

Parameters

container

A container object.

Returns

Success or failure status.

This method invokes the corresponding method of the GlgObject class. See DeleteBottomObject for more information.

DeleteObject()

virtual bool DeleteObject ( GlgObject  container, Object  object  )

virtual

Finds and deletes an object from the container.

Parameters

container	A container object.
object	An object to be deleted.

Returns

true if the object was successfully deleted. If the object was not found, the method returns false without generating an error message.

This method invokes the corresponding method of the GlgObject class.

DeleteObjectAt()

virtual bool DeleteObjectAt ( GlgObject  container, int  index  )

virtual

Deletes an object from the specified position in the container.

Parameters

container	A container object.
index	An index of the object to be deleted.

Returns

Success or failure status.

This method invokes the corresponding method of the GlgObject class.

DeleteTopObject()

virtual bool DeleteTopObject ( GlgObject  container )

virtual

Deletes an object from the beginning of the container.

Parameters

container

A container object.

Returns

Success or failure status.

This method invokes the corresponding method of the GlgObject class.

SetResourceObject()

virtual bool SetResourceObject ( GlgObject  glg_object, String  resource_name, GlgObject  value  )

virtual

Replaces a resource object inside the object the method is invoked on.

Parameters

glg_object	The object to replace resources of.
resource_name	A default attribute name of a resource that is being set or replaced.
value	A new resource object.

Returns

Success or failure status.

This method invokes the corresponding method of the GlgObject class. See SetResourceObject for more information.

SetXform()

virtual bool SetXform ( GlgObject  glg_object, GlgObject  xform  )

virtual

Adds or deletes transformations attached to the object.

Parameters

glg_object	The object whose transformation will be added or deleted.
xform	A new transformation object to be attached to the object the method is invoked on, or null to delete the currently attached transformation.

Returns

Success or failure status.

This method invokes the corresponding method of the GlgObject class. See SetXform for more information.