CustomGraphicsEntity.depthPriority Property

Description

Gets and sets the depth priority associated with the graphics entity. The depth priority defines how one graphics entity will be drawn with respect to another entity. This is useful when there are entities that lie in the same space so it's ambiguous which should be drawn on the other. For example, if you draw a curve on a planar mesh and want the curve to be completely visible. You can set the depth priority of the curve to be greater than the mesh so it will be drawn after the mesh and will remain visible.

When a new graphics entity is created it's default depth priority is 0.

Syntax

# Get the value of the property.
propertyValue = customGraphicsEntity_var.depthPriority

# Set the value of the property.
customGraphicsEntity_var.depthPriority = propertyValue

#include <Fusion/Graphics/CustomGraphicsEntity.h>

// Get the value of the property.
integer propertyValue = customGraphicsEntity_var->depthPriority();

// Set the value of the property, where value_var is an integer.
bool returnValue = customGraphicsEntity_var->depthPriority(value_var);

Property Value

Version