GraphObject

class compas.scene.GraphObject

Bases: SceneObject

Scene object for drawing graph data structures.

Parameters:

graphcompas.datastructures.Graph

A COMPAS graph.

See also

compas.scene.MeshObject

compas.scene.VolMeshObject

Attributes:

graphcompas.datastructures.Graph

The COMPAS graph associated with the scene object.

node_xyzdict[hashable, list[float]]

Mapping between nodes and their view coordinates. The default view coordinates are the actual coordinates of the nodes of the graph.

nodecolorcompas.colors.ColorDict

Mapping between nodes and RGB color values.

edgecolorcompas.colors.ColorDict

Mapping between edges and colors.

nodesizefloat

The size of the nodes. Default is 1.0.

edgewidthfloat

The width of the edges. Default is 1.0.

show_nodesUnion[bool, sequence[float]]

Flag for showing or hiding the nodes. Default is True.

show_edgesUnion[bool, sequence[tuple[hashable, hashable]]]

Flag for showing or hiding the edges. Default is True.

Methods

clear	Clear the nodes and the edges of the graph.
clear_edges	Clear the edges of the graph.
clear_nodes	Clear the nodes of the graph.
draw	Draw the network.
draw_edges	Draw the edges of the graph.
draw_nodes	Draw the nodes of the graph.

Inherited Methods

ToString	Converts the instance to a string.
add	Add a child item to the scene object.
copy	Make an independent copy of the data object.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
remove	Remove a child node from this node.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
to_json	Convert an object to its native data representation and save it to a JSON file.
to_jsonstring	Convert an object to its native data representation and save it to a JSON string.
traverse	Traverse the tree from this node.
validate_data	Validate the data against the object's data schema.