IGH_IconObject

References
public interface IGH_IconObject : GH_ISerializable
Represents a procedural object inside an Icon image.

Properties

Image

#
Bitmap Image { get; }
Gets the object image. Do not store pointers to this image as it might be disposed at any time.

ObjectID

#
Guid ObjectID { get; }
Gets the icon object ID.

Pivot

#
Point Pivot { get; set; }
Gets or sets the pivot point for this object.

Size

#
Size Size { get; set; }
Gets or sets the size of the object container. Setting the Size does not adjust the geometry, call Resize() instead.

Methods

Contains

#
bool Contains(PointF pt)
Tests a floating point coordinate for shape inclusion.
Parameters:
pt (PointF)Point to test for inclusion.
Returns: True if pt is inside the object boundary.

Grips

#
List<IGH_IconObjectGrip> Grips()
Gets a list of Icon object grips.
Returns: A list of grips or null if this object does not support grips.

Read

bool Read(GH_IReader reader)
This method is called whenever the instance is required to deserialize itself.
inherited fromGH_ISerializable
Parameters:
reader (GH_IReader)Reader object to deserialize from.
Returns: True on success, false on failure.

RenderObject

#
void RenderObject(Graphics G)
Draw this object inside the specified graphics surface.
Parameters:
G (Graphics)Graphics object to draw with.

Resize

#
void Resize(Size newSize)
Set a new size for this object and resize the geometry to adapt to the new container.
Parameters:
newSize (Size)New size for this object.

Write

bool Write(GH_IWriter writer)
This method is called whenever the instance is required to serialize itself.
inherited fromGH_ISerializable
Parameters:
writer (GH_IWriter)Writer object to serialize with.
Returns: True on success, false on failure.