Rosette
class compolyx.Rosette(graph, obj, parent=None)
Rosette class.
Access:
>>> model = db.models['class40.1']
>>> rosette_1 = model.rosettes['Rosette.1']
>>> rosette_2 = model.create_rosette(name='Rosette.2', origin=(1.5, 5.75, 7.), dir1=(-0.4, -0.4, 0.8), dir2=(-6.0, 0.6, 0.75), rosette_type='parallel' )
Attributes
| Name | Description |
|---|---|
Rosette.active | Active status of object |
Rosette.changed | Status boolean |
Rosette.dir1 | Direction 1 of the Rosette |
Rosette.dir2 | Direction 2 of the Rosette |
Rosette.edge_set | Edge Set for Rosette |
Rosette.enabled | Whether this object is currently enabled or not |
Rosette.id | ID of object |
Rosette.is_dict_item | Specifies wether the object is an item of a dict |
Rosette.is_list_item | Specifies wether the object is an item of a list |
Rosette.link_path | Root path of the current node in the tree for links to this object |
Rosette.locked | Rosette is generated from an imported rosette and cannot be changed |
Rosette.name | Name of object |
Rosette.origin | Origin of the Rosette |
Rosette.parent | Parent object in tree |
Rosette.root_path | Root path of the current node in the tree |
Rosette.rosette_type | Rosette Types. Available options: parallel, radial, cylindrical, spherical, edge_wise |
Rosette.status | Status of the object |
Rosette.status_changed | Boolean flag which is set to true in C++ when up-to-date status of object changes |
Rosette.uid | UID of object |
Rosette.vertex | This will throw an error if the object has been removed from the graph |
Methods
| Name | Description |
|---|---|
Rosette.find_parent(type) | Function steps up the tree and returns the first parent with given type |
Rosette.get_global_coordinates(coordinates) | Evaluates the global coordinates of a point given in local rosette coordinates: CYLINDRICAL, RADIAL, and SPHERICAL |
Rosette.get_global_vector_components(vector) | Gets global vector components from local rosette vector components CYLINDRICAL, RADIAL and SPHERICAL coord sys type: Give phi and theta in RAD |
Rosette.get_local_coordinates(coordinates) | Evaluates the local rosette coordinates of a point given in global coordinates |
Rosette.get_local_vector_components(vector) | Returns local rosette vector components from global vector components |
Rosette.get_short_description() | |
Rosette.local_direction(point, angle) | Get local orientation for a given relative angle and position in space |
Rosette.obj_exists() | Checks if __obj still references the c++ object (i.e. has not been reset to None by self._delete) AND exists in the graph |
Rosette.rotate(rot_x_angle_deg, ...) | Rotate the Rosette around its X, Y and Z axes as an intrisic rotation |
Rosette.serialize() | Serialize to Python string |
Rosette.serialize_name_and_id() | Helper function to serialize name and ID |
Rosette.set_Xy() | Sets dir2 orthogonal to dir1 as y- and x-axis |
Rosette.set_Xz() | Sets dir2 orthogonal to dir1 as z- and x-axis |
Rosette.set_Yz() | Sets dir2 orthogonal to dir1 as z- and y-axis |
Rosette.set_xY() | Sets dir1 orthogonal to dir2 as x- and y-axis |
Rosette.set_xZ() | Sets dir1 orthogonal to dir2 as x- and z-axis |
Rosette.set_yZ() | Sets dir1 orthogonal to dir2 as y- and z-axis |
Rosette.translate(translation_x, ...) | Translate the rosette, either along its own axes or the global one depending on the type of translation |
Rosette.update() | |
Rosette.visit(visitor) | Walk through the tree and let the visitor perform action on every descendant node |