OrderedCompositePrimitive Class

A primitive composed of other primitives with a well defined render order. The ordered composite is intended to contain overlapping primitives rendered on the globe's surface. Which primitives are on top of which primitives is defined by the position of the primitive in the composite, which can be controlled with Add(Primitive), BringToFront(Primitive), BringForward(Primitive), SendBackward(Primitive), and SendToBack(Primitive).

The ordered composite is compatible with the following primitives:

It is not intended for use with: ModelPrimitive, SolidPrimitive, or CompositePrimitive.

Primitives in a composite must have the same ReferenceFrame.

Inheritance Hierarchy

SystemObject
AGI.Foundation.GraphicsPrimitive
AGI.Foundation.GraphicsOrderedCompositePrimitive

Namespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.1.418.0 (24.1.418.0)

Syntax

C++

Copy

public sealed class OrderedCompositePrimitive : Primitive, 
	IEnumerable<Primitive>

Public NotInheritable Class OrderedCompositePrimitive
	Inherits Primitive
	Implements IEnumerable(Of Primitive)

public ref class OrderedCompositePrimitive sealed : public Primitive, 
	IEnumerable<Primitive^>

[<SealedAttribute>]
type OrderedCompositePrimitive =  
    class
        inherit Primitive
        interface IEnumerable<Primitive>
    end

The OrderedCompositePrimitive type exposes the following members.

Constructors

	Name	Description
	OrderedCompositePrimitive	Initializes a default ordered composite primitive.

Top

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. (Inherited from Primitive.)
	Color	The ordered 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. (Overrides PrimitiveDisplayCondition.)
	Item	Returns the primitive at the given zero-based index. The primitive at index zero is rendered on the bottom and the primitive at index Count - 1 is rendered on the top.
	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 ordered composite primitive does not support the translucency property. (Overrides PrimitiveTranslucency.)

Top

Methods

	Name	Description
	Add	Adds a primitive to the front of the composite. Primitives at the front are rendered on top of primitives at the bottom.
	BringForward	Moves a primitive in the composite forward one slot. Primitives at the front are rendered on top of primitives at the bottom.
	BringToFront	Moves a primitive to the top of the composite, so that it is rendered on top of all other primitives in 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 each primitive in the composite.
	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.
	SendBackward	Moves a primitive in the composite backwards one slot. Primitives at the bottom are rendered below primitives at the front.
	SendToBack	Moves a primitive to the bottom of the composite, so that it is rendered below all other primitives in the composite.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.Graphics Namespace

OrderedCompositePrimitiveAdd(Primitive)

OrderedCompositePrimitiveBringToFront(Primitive)

OrderedCompositePrimitiveBringForward(Primitive)

OrderedCompositePrimitiveSendBackward(Primitive)

OrderedCompositePrimitiveSendToBack(Primitive)

AGI.Foundation.GraphicsCompositePrimitive

Other Resources

Ordered Composite Primitive topic