CLASSIFIER : GRFrame

uid: class-GRFrame-CVEViewer-MetaModel@g-scop.grenoble-inp.fr

About

Abstract

A GRFrame is a graphic node visualizing a simple Frame with subitems to select axis, rotations, or center.

We can manage which axis and rotations are visible and selectable. The default label can be renamed.

Red stands for X axis, Green for Y axis and Blue for Z axis.

To create a GRFrame just call

cube=cve.viewer.GRCube(labelx='X',labely='Y',labelz='Z',
                         selectable=['Center','X','Y','Z','RX','RY','RZ'],
                         selected=['Center','X','Y','Z','RX','RY','RZ'],
                         visible=['Center','X','Y','Z','RX','RY','RZ'])

where :

• labelx: string the label of X axis
• labely: string the label of Y axis
• labelz: string the label of 2 axis
• selectable: the list of selectable items within : [‘Center’,’X’,’Y’,’Z’,’RX’,’RY’,’RZ’]
• param selected: the list of selected items within : [‘Center’,’X’,’Y’,’Z’,’RX’,’RY’,’RZ’]
• visible: the list of visible items within : [‘Center’,’X’,’Y’,’Z’,’RX’,’RY’,’RZ’]

Class Diagram

Inherits

• GRNODE

  Attributes table

Methods

• set_selectable(self,..) :

            Method to say what is selectable
            :param self: the GRFrame object
            :param selectable: a list of the following strings ['Center','X','Y','Z','RX','RY','RZ']
            :param local:   if event is also propagated in the local loop
  

• get_selectable(self,..) :

        Method to get what is selectable
        :param self:
        :return: a list of strings telling what is selectable : ['Center','X','Y','Z','RX','RY','RZ']
  

• set_selected(self,..) :

            Method to say what is selected
            :param self: the GRFrame object
            :param selected: a list of the following strings ['Center','X','Y','Z','RX','RY','RZ']
            :param local:   if event is also propagated in the local loop
  

• get_selected(self,..) :

        Method to get what is selected
        :param self:
        :return: a list of strings telling what is selected : ['Center','X','Y','Z','RX','RY','RZ']
  

• set_visible(self,..) :

        Method to say what is visible
        :param self: the GRFrame object
        :param visible: a list of the following strings ['Center','X','Y','Z','RX','RY','RZ']
        :param local:   if event is also propagated in the local loop
  

• get_visible(self,..) :

        Method to get what is visible
        :param self:
        :return: a list of strings telling what is visible : ['Center','X','Y','Z','RX','RY','RZ']
  

• set_labelx(self,..) :

        Set the label for X axis ('X' by default)
        :param self: the GRFrame object
        :param label: the new X axis label
        :param local:  if event is also propagated in the local loop
  

• get_labelx(self,..) :

        Get current label for X axis
        :param self: the GRFrame object
        :return: the expected label (a string)
  

• set_labely(self,..) :

        Set the label for Y axis ('Y' by default)
        :param self: the GRFrame object
        :param label: the new Y axis label
        :param local:  if event is also propagated in the local loop
  

• get_labely(self,..) :

        Get current label for Y axis
        :param self: the GRFrame object
        :return: the expected label (a string)
  

• set_labelz(self,..) :

        Set the label for Z axis ('Z' by default)
        :param self: the GRFrame object
        :param label: the new Z axis label
        :param local:  if event is also propagated in the local loop
  

• get_labelz(self,..) :

        Get current label for Z axis
        :param self: the GRFrame object
        :return: the expected label (a string)