Click or drag to resize

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: 19.5.402.0 (19.5.402.0)
Syntax
public sealed class OrderedCompositePrimitive : Primitive, 
	IEnumerable<Primitive>

The OrderedCompositePrimitive type exposes the following members.

Constructors
  NameDescription
Public methodOrderedCompositePrimitive
Initializes a default ordered composite primitive.
Top
Properties
  NameDescription
Public propertyAutomaticallyComputeBoundingSphere
Gets or sets if the primitive's BoundingSphere is automatically computed.
(Inherited from Primitive.)
Public propertyBoundingSphere
Gets or sets the bounding sphere that encompasses the primitive. The center is defined in the primitive's ReferenceFrame.
(Inherited from Primitive.)
Public propertyColor
The ordered composite primitive does not support the color property.
(Overrides PrimitiveColor.)
Public propertyCount
Gets the number of primitives in the composite.
Public propertyDisplay
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.)
Public propertyDisplayCondition

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.)
Public propertyItem
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.
Public propertyReferenceFrame
Gets or sets the reference frame this primitive is defined and rendered in.
(Overrides PrimitiveReferenceFrame.)
Public propertyTag
Gets or sets custom data associated with this primitive.
(Inherited from Primitive.)
Public propertyTranslucency
The ordered composite primitive does not support the translucency property.
(Overrides PrimitiveTranslucency.)
Top
Methods
  NameDescription
Public methodAdd
Adds a primitive to the front of the composite. Primitives at the front are rendered on top of primitives at the bottom.
Public methodBringForward
Moves a primitive in the composite forward one slot. Primitives at the front are rendered on top of primitives at the bottom.
Public methodBringToFront
Moves a primitive to the top of the composite, so that it is rendered on top of all other primitives in the composite.
Public methodClear
Removes all primitives from the composite.
Public methodContains
Determines whether the composite contains a primitive.
Public methodDispose (Inherited from Primitive.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through each primitive in the composite.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemove
Removes a primitive from the composite.
Public methodSendBackward
Moves a primitive in the composite backwards one slot. Primitives at the bottom are rendered below primitives at the front.
Public methodSendToBack
Moves a primitive to the bottom of the composite, so that it is rendered below all other primitives in the composite.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also