CompositePrimitive Class |
A primitive that is composed of multiple other primitives. Since composites can contain other composites, they are commonly used to build hierarchies of primitives to efficiently evaluate display conditions.
Primitives in a composite must have the same ReferenceFrame.
Inheritance HierarchyNamespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.2.419.0 (24.2.419.0)
SyntaxThe CompositePrimitive type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CompositePrimitive |
Initializes a default composite primitive.
|
Properties| Name | Description | |
|---|---|---|
 | AutomaticallyComputeBoundingSphere |
Gets or sets if the primitive's BoundingSphere is automatically computed.
(Inherited from Primitive.) |
| BoundingSphere |
Gets or sets the bounding sphere that encompasses the primitive.
The center is defined in the primitive's ReferenceFrame.
(Overrides PrimitiveBoundingSphere.) |
| Color |
The composite primitive does not support the color property.
(Overrides PrimitiveColor.) |
| Count |
Gets the number of primitives in the composite.
|
| Display |
Gets or sets if the primitive should be
rendered.
Both this and DisplayCondition must evaluate to true for
the primitive to be rendered.
(Inherited from Primitive.) |
| DisplayCondition | Gets or sets the composite's display condition. During rendering, first a composite's display condition is evaluated. If it succeeds, the display condition for each primitive in the composite is evaluated. |
| ReferenceFrame |
Gets or sets the reference frame this primitive is defined and rendered in.
(Overrides PrimitiveReferenceFrame.) |
| Tag |
Gets or sets custom data associated with this primitive.
(Inherited from Primitive.) |
| Translucency |
The composite primitive does not support the translucency property.
(Overrides PrimitiveTranslucency.) |
| TranslucentPrimitivesSortOrder |
Gets or sets the sort order for translucent primitives in this composite.
This determines a trade-off between rendering speed and quality. It
is only recommended to use
PrimitivesSortOrderBackToFront
when translucent primitives along the same line of sight cause blending artifacts.
|
Methods| Name | Description | |
|---|---|---|
| Add |
Adds a primitive to the composite.
|
| Clear |
Removes all primitives from the composite.
|
| Contains |
Determines whether the composite contains a primitive.
|
| Dispose | (Inherited from Primitive.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
The order of the primitives is not guaranteed to be the order
that the primitives were added.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Remove |
Removes a primitive from the composite.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also