Class vdSectionClips
- Namespace
- VectorDraw.Professional.vdCollections
- Assembly
- VectorDraw.Professional.dll
Represents a collection of vdSectionClip objects and provides helpers to manage and apply section clipping during rendering and geometric tests. It is generally accessed via Sections property of a vdLayout objec.
public sealed class vdSectionClips : vdBaseObject, IDisposable, IVDSerialise, IEnumerable, IBaseObject- Inheritance
-
vdSectionClips
- Implements
- Inherited Members
Remarks
The vdSectionClips collection holds section clip objects that can be applied to the current display. The implementation forwards rendering, clipping and visibility queries to each enabled vdSectionClip in the collection. Deleted items are generally ignored by public operations. The collection enforces a practical limit of six enable section clips for display purposes
Typical usage:
- Add or remove vdSectionClip instances via AddItem(vdSectionClip), RemoveItem(vdSectionClip) or RemoveAt(int).
- Call ApplySectionClips(vdRender) to apply the active clips to a render pass or use methods such as IsSectionVisible(gPoint, Matrix) and ClipLine(gPoint, gPoint, ref gPoint, ref gPoint) for geometric queries.
Constructors
- vdSectionClips()
Initializes the vdSectionClips collection object.
Properties
- Count
Get the item's count of the collection.
- this[int]
Get a vdSectionClip object from the collection at a specified index.
- ItemType
Returns the Type of Items in the collection
- Last
Returns the last item in the collection.
- NumofValid
Returns the number of Enabled Sections in the collection
Methods
- Add(object)
Adds an object to the end of the collection.
- Add(string)
Creates and adds a vdSectionClip object to the collection with the specified name.
- AddItem(object)
Adds an item to the collection.
- AddItem(vdSectionClip)
Adds a vdSectionClip object to the collection.
- ApplySectionClips(vdRender)
Apply all enabled vdSectionClip object of this collection to passed vdRender object.
- CLipPoints(vdArray<gPoints>)
Apply the clipping of all enabled sections to the passed points.Pass points may be changed after the method return.
- CLipPoints(gPoints)
Apply the clipping of all enabled sections to the passed points.Pass points may be changed after the method return.
- ChangeOrder(vdSectionClip, bool)
Changes the position of a vdSectionClip object to the front or the end of the collection.
- ClipLine(gPoint, gPoint, ref gPoint, ref gPoint)
Gets the portion of a line that is visible to all sections of the collection
- CreateSectionCoverFacesList(vdRender, IntPtr, IRenderListItem)
Internally used only.Create a list for each section in collection, that contains the section clip cover faces for a specific drawing figure defined by listItem parameter
- DeSerialize(DeSerializer, string, object)
This Function is called foreach field name of the vdSectionClips object when opening in vdml format.
- Dispose()
Releases all resources used by this object.
- FindFromId(int)
Gets an object that belongs to collection passing through its ID number.
- FindItem(ISectionClip)
Checks if an object exists in the collection.
- FindItem(vdSectionClip)
Checks if an object exists in the collection.
- FindName(string)
Finds a vdSectionClip object with the specified name in the collection.
- GetEnumerator()
Implements the "foreach" expression for the collection.
- GetItem(int)
Get a ISectionClip object from the collection at a specified index.
- GetItemAtIndex(int)
Get an item at the specified index.
- GetNotDeletedItems()
Get all non deleted objects of the collection.
- InsertAt(int, vdSectionClip)
Insert a vdSectionClip object to a specified index of the collection.
- InternalSetOwner(vdBaseObject)
Internally used only.
Set the object owner
- IsSectionVisible(gPoint)
Checks if the passed point is visible from all section clips of the collection
- IsSectionVisible(gPoint, Matrix)
Checks if the passed point is visible from all section clips of the collection
- IsSectionVisible(gPoints, Matrix)
Checks if all points are visible from all section clips of the collection
- RemoveAll()
Removes all objects from the collection.
- RemoveAt(int)
Removes all objects from the collection.
- RemoveItem(vdSectionClip)
Removes a specific vdSectionClip object from the collection.
- Serialize(Serializer)
This Function is called when saving the vdSectionClips object to vdml format.
- ToString()
Gets a System.String that represents the count of the vdSectionClips collection Object.
- Update()
Updates all calculated object values.
- getUniqueTableName(string)
Creates a unique string for use as name to a vdLayout object.
- swap(vdSectionClip, vdSectionClip)
Swaps the position between two different vdSectionClip objects existing in the collection.