GraphicsDataSetsCollection Object

Description

The ClientGraphicsCollection object allows you to create new objects and supports access to existing GraphicsDataSets objects. See the article in the overview section for more information.

Methods

Add

Method that creates a new GraphicsDataSets object. When the GraphicsDataSetsCollection object is obtained from a Document, this will always create a transient graphics data object. That is, its lifetime is only for the period of time the document is open.

When the GraphicsDataSetsCollection object is obtained from a ClientFeatureDefinition object, the graphics data objects created are persistent and will be saved with the document. In that case it is only intended to be used for graphics that are associated with a client feature.

Properties

Name	Description
Application	Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
Count	Property that returns the number of coordinates defined within the set.
Item	Returns an existing GraphicsDataSets object.
NonTransacting	Read-only property that returns whether the creation of this GraphicsDataSetsCollection object and all its associated data is non-transacting.
Parent	Property returns the parent document of this object.
Type	Returns an ObjectTypeEnum indicating this object's type.

Accessed From

Samples

Name	Description
Client Graphics - Vertex Color by Z Height	This sample demonstrates using client graphics and some other functions that help to support display control. It uses the currently active part and replaces the part display with a display where the part's color varies from blue to red where blue is assigned to the lowest Z portion of the part and red is assigned to the highest Z portion of the part. Areas in between are represented by a smooth blend of color from blue to red.
Client Graphics - Line	This sample demonstrates the creation of custom graphics using LineGraphics and LineStripGraphics. The same set of coordinate data is used for both types of graphics. Line graphics use two coordinates to define a line, and then the next two coordinates to define the next line, and so on through the defined coordinates. For the data provided, this results in gaps in the drawn curve. Line strips use the first two coordinates to define the first line and then the last point of the first line becomes the first point of the second line and the next coordinate is used as the end point of the second line. This results in the set of points being connected by a continuous set of lines, drawing a continuous curve. This sample also demonstrates two methods of defining the color for client graphics. In one case it uses an existing appearance asset, and in the other, it explicitly defines a color and assigns it. To use the sample you need to have an assembly or part document open. The program has two behaviors: the first time it is run it will draw the graphics. The second time it is run it deletes the previously drawn graphics.
Client Graphics - Triangle	This sample demonstrates the creation of client graphics triangles using triange fans and strips. It does this by drawing a cylinder. The end caps are triangle fans and the cylinder is made from a triangle strip.
Client graphics - image in point graphics	The following sample demonstrates creation of point client graphics with a custom image.

Version

Introduced in version 5