RiverSoftAVG Products Help

Tag

The tag property is intended for the interface user to assign whatever value they like to the tag. The tag should be cloned and assigned. A common use for the tag would be to assign the object that the object represents so that the object is available later.

The Tag property calls the     GetTag and     SetTag methods.

X

Defines the X, or horizontal, location. The property calls the GetX and SetX methods

Y

Defines the Y, or vertical, location. The property calls the GetY and SetY methods

Z

Defines the Z, or depth, location. The property calls the GetZ and SetZ methods

Assign(IInterface)

Overloaded. Attempts to copy the fields or data from AValue into the underlying object. If the AValue parameter is not of an interface type that is understood by the object, it should raise an exception. (Inherited from CommonInterfaces.ICloneable.)

Assign(TPersistent)

Overloaded. Attempts to copy the fields or data from source object into the underlying object. (Inherited from CommonInterfaces.ICloneable.)

AssignTo(TPersistent)

Attempts to copy the fields or data from the underlying object into the Destination object. (Inherited from CommonInterfaces.ICloneable.)

Clone

The Clone method is intended to return a copy of the interface object. It is up to the interface implementer whether the clone is a shallow or deep copy. Please refer to the other interface documentation. A common implementation of this method creates the underlying object and then calls the Assign method.

Note that this method returns an IInterface and may need to be cast in order to assign it to another variable of a descendant interface type.
 

Equals(IInterface)

This method is intended to compare two interface objects and return whether they are equal. The comparison can be shallow (compare pointers) or deep (compare data) depending on the implementor. Please refer to the documentation of the objects for more information.
 (Inherited from CommonInterfaces.ICloneable.)

GetTag

This method is called by the CommonInterfaces.ICloneable.Tag property. It should return the same value that the tag property is set to using the   SetTag method. (Inherited from CommonInterfaces.ICloneable.)

GetX

The GetX method returns the X, or horizontal, location of the underlying object. This method is called by the X property and should return the same value stored there by the SetX method.
 

GetY

The GetX method returns the Y, or vertical, location of the underlying object. This method is called by the Y property and should return the same value stored there by the SetY method.
 

GetZ

The GetZ method returns the Z, or depth, location of the underlying object. This method is called by the Z property and should return the same value stored there by the SetZ method.
 

get_Tag

This method is called by the CommonInterfaces.ICloneable.Tag property. It should return the same value that the tag property is set to using the   SetTag method.

get_X

The GetX method returns the X, or horizontal, location of the underlying object. This method is called by the X property and should return the same value stored there by the SetX method.
 

get_Y

The GetX method returns the Y, or vertical, location of the underlying object. This method is called by the Y property and should return the same value stored there by the SetY method.

get_Z

The GetZ method returns the Z, or depth, location of the underlying object. This method is called by the Z property and should return the same value stored there by the SetZ method.

SetTag(TRSTag)

This method is intended to store an arbitrary integer value. It is called by the Tag property. GetTag method should return the same value later.
 (Inherited from CommonInterfaces.ICloneable.)

SetX(Single)

Stores the Value in the X, or horizontal, location for the underlying object. This method is called by the X property and should store the value in the same place that the GetX method retrieves from.
 

SetXYZ(Single,Single,Single)

The SetXYZ method sets the coordinates for the location all at once.
 

SetY(Single)

Stores the Value in the Y, or vertical, location for the underlying object. This method is called by the Y property and should store the value in the same place that the GetY method retrieves from.
 

SetZ(Single)

Stores the Value in the Z, or depth, location for the underlying object. This method is called by the Z property and should store the value in the same place that the GetZ method retrieves from.
 

set_Tag(TRSTag)

This method is intended to store an arbitrary integer value. It is called by the Tag property. GetTag method should return the same value later.

set_X(Single)

Stores the Value in the X, or horizontal, location for the underlying object. This method is called by the X property and should store the value in the same place that the GetX method retrieves from.

set_Y(Single)

Stores the Value in the Y, or vertical, location for the underlying object. This method is called by the Y property and should store the value in the same place that the GetY method retrieves from.

set_Z(Single)

Stores the Value in the Z, or depth, location for the underlying object. This method is called by the Z property and should store the value in the same place that the GetZ method retrieves from.