ImageDefinition

class HPS.ImageDefinition : public HPS.Definition

The ImageDefinition class is a smart pointer to a database object. It is a handle to an image defined within a portolfio.

Public Functions

override void Dispose ()

ImageDefinition ()

The default constructor creates an uninitialized ImageDefinition object. The Type() function will return Type.None.

ImageDefinition (HPS.Definition in_that)

This constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of an image definition. Otherwise the copy will fail and the resulting ImageDefinition will be invalid.

Param in_that

The source Definition to copy.

ImageDefinition (HPS.ImageDefinition in_that)

The copy constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source ImageDefinition.

Param in_that

The source ImageDefinition to copy.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.ImageKit in_kit)

Redefine the image for this ImageDefinition.

Param in_kit

The new image for this ImageDefinition.

void Show (out HPS.ImageKit out_kit)

Shows the image for this ImageDefinition.

Param out_kit

The image for this ImageDefinition.