entities.density.annotations

entities.density.annotations

Classes

Name	Description
DensityAnnotation	Base class for a Density Annotation
DensityAnnotationManager	Annotation Manager for Density Entity
DensityGridAxes	Density Grid Axes Annotation
DensityInfo	Density Info Annotation
Label2D	Common Label2D Annotation for all entities
Label3D	Common Label3D Annotation for all entities

DensityAnnotation

entities.density.annotations.DensityAnnotation(self, density)

Base class for a Density Annotation

All density annotations should derive from this base class and implement the ‘draw’ method. All derived classes will have access to the density instance (self.density) and all the annotation inputs and common params via self.interface.

An optional ‘defaults’ method can be provided to set default values to the annotation.

DensityAnnotationManager

entities.density.annotations.DensityAnnotationManager(self, entity)

Annotation Manager for Density Entity

DensityGridAxes

entities.density.annotations.DensityGridAxes(self, density)

Density Grid Axes Annotation

Attributes

Name	Type	Description
show_length	bool	Whether or not to show the length of the grid axes
units	str	Units to use for length. Default: Å

DensityInfo

entities.density.annotations.DensityInfo(self, density)

Density Info Annotation

Attributes

Name	Type	Description
location	tuple[float, float]	Normalized coordinates (0.0 - 1.0) of the postion in viewport / render
show_filename	bool	Whether or not to show the grid filename
show_threshold	bool	Whether or not to show the current threshold value
show_origin	bool	Whether or not to show the grid origin
show_delta	bool	Whether or not to show the grid delta
show_shape	bool	Whether or not to show the grid shape
custom_text	str	Any custom text to add at the end of the annotation

Label2D

entities.density.annotations.Label2D()

Common Label2D Annotation for all entities

Label3D

entities.density.annotations.Label3D()

Common Label3D Annotation for all entities