IGLib  1.7.2
The IGLib base library for development of numerical, technical and business applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Gr.GraphicObject Class Reference

Graphic object, a tree - like collection of graphic primitives. More...

+ Collaboration diagram for IG.Gr.GraphicObject:

Public Member Functions

virtual void Add (GraphicPrimitive primitive)
 Adds a graphic primitive to the object. More...
 
virtual void Add (GraphicObject grobject)
 Adds a child graphic object to the current objects. More...
 
virtual GraphicObject GetDirectChildObject (int i)
 Returns tha direct child object No. i. More...
 
virtual void AddChildObject (GraphicObject grobject)
 Adds a child object to the graphic object. More...
 
virtual GraphicPrimitive GetDirectPrimitive (int i)
 Returns the primitive No. i that is directly contained on this graphic object. Primitives contained in descendant objects are excluded. More...
 

Properties

virtual GraphicObject Parent [get, set]
 Gets the parent object of this object (if there exists). More...
 
virtual int NumDirectChildObjects [get]
 Gets the number of child objects of the current element (descendants of higher leval are excluded). More...
 
virtual int NumObjects [get]
 Gets the total number of descendant objects. More...
 
virtual int NumDirectPrimitives [get]
 Gets the number of graphic primitives directly contained in this object. This does NOT include the primitive contained in descendant objects. More...
 
virtual int NumPrimitives [get]
 Gets the total number of graphic primitives contained in this object, which includes primitives of all descendant graphic objects. More...
 
virtual GrPrimitiveSettings Settings [get, protected set]
 Gets the primitive's internal graphic properties (such as color, etc.) More...
 
virtual GrPrimitiveSettings EffectiveSettings [get]
 

Private Attributes

GraphicObject _parent = null
 
List< GraphicObject_childobjects = new List<GraphicObject>()
 
List< GraphicPrimitive_primitives = new List<GraphicPrimitive>()
 
GrPrimitiveSettings _settings = null
 

Detailed Description

Graphic object, a tree - like collection of graphic primitives.

Member Function Documentation

virtual void IG.Gr.GraphicObject.Add ( GraphicPrimitive  primitive)
inlinevirtual

Adds a graphic primitive to the object.

virtual void IG.Gr.GraphicObject.Add ( GraphicObject  grobject)
inlinevirtual

Adds a child graphic object to the current objects.

Parameters
grobjectGraphic object that is added as a child object.
virtual GraphicObject IG.Gr.GraphicObject.GetDirectChildObject ( int  i)
inlinevirtual

Returns tha direct child object No. i.

Parameters
iIndex of the child object to return.
Returns
The direct child object No i.
Exceptions
IndexOutOfRangeExceptionWhen index is out of range.
virtual void IG.Gr.GraphicObject.AddChildObject ( GraphicObject  grobject)
inlinevirtual

Adds a child object to the graphic object.

virtual GraphicPrimitive IG.Gr.GraphicObject.GetDirectPrimitive ( int  i)
inlinevirtual

Returns the primitive No. i that is directly contained on this graphic object. Primitives contained in descendant objects are excluded.

Parameters
iZero-based index of the primitive.
Returns
The specified primitive that is directly contained in the current graphic object.
Exceptions
ArgumentOutOfRangeExceptionWhen index is out of range.

Member Data Documentation

GraphicObject IG.Gr.GraphicObject._parent = null
private
List<GraphicObject> IG.Gr.GraphicObject._childobjects = new List<GraphicObject>()
private
List<GraphicPrimitive> IG.Gr.GraphicObject._primitives = new List<GraphicPrimitive>()
private
GrPrimitiveSettings IG.Gr.GraphicObject._settings = null
private

Property Documentation

virtual GraphicObject IG.Gr.GraphicObject.Parent
getset

Gets the parent object of this object (if there exists).

virtual int IG.Gr.GraphicObject.NumDirectChildObjects
get

Gets the number of child objects of the current element (descendants of higher leval are excluded).

virtual int IG.Gr.GraphicObject.NumObjects
get

Gets the total number of descendant objects.

virtual int IG.Gr.GraphicObject.NumDirectPrimitives
get

Gets the number of graphic primitives directly contained in this object. This does NOT include the primitive contained in descendant objects.

virtual int IG.Gr.GraphicObject.NumPrimitives
get

Gets the total number of graphic primitives contained in this object, which includes primitives of all descendant graphic objects.

virtual GrPrimitiveSettings IG.Gr.GraphicObject.Settings
getprotected set

Gets the primitive's internal graphic properties (such as color, etc.)

virtual GrPrimitiveSettings IG.Gr.GraphicObject.EffectiveSettings
get

The documentation for this class was generated from the following file: