Source code for creopyson.layer

"""Layer module."""


[docs]def delete(client, name=None, file_=None): """Delete one or more layers. Args: client (obj): creopyson Client. name (str, optional): Layer name (wildcards allowed: True). Defaults: All layers will be deleted. `file_` (str, optional): File name (wildcards alloawed: True). Defaults is current active model. Returns: None """ data = {"name": name} if file_ is not None: data["file"] = file_ else: active_file = client.file_get_active() if active_file: data["file"] = active_file["file"] if name is not None: data["name"] = name return client._creoson_post("layer", "delete", data)
[docs]def exists(client, name=None, file_=None): """Check whether layer(s) exists on a model. Args: client (obj): creopyson Client. name (str, optional): Layer name (wildcards allowed: True). Defaults: All layers are listed. `file_` (str, optional): File name. Defaults is current active model. Returns: (boolean): Whether the layer exists on the model. """ data = {} if file_ is not None: data["file"] = file_ else: active_file = client.file_get_active() if active_file: data["file"] = active_file["file"] if name is not None: data["name"] = name return client._creoson_post("layer", "exists", data, "exists")
[docs]def list_(client, name=None, file_=None): """List layers that match criteria. Args: client (obj): creopyson Client. name (str, optional): Layer name (wildcards allowed: True). Defaults: All layers are listed. `file_` (str, optional): File name. Defaults is current active model. Returns: (list:dict): name (str): Layer name. status (str): Layer status. Valid values: BLANK, DISPLAY, HIDDEN, NORMAL. ID (int): Layer ID. """ data = {} if file_ is not None: data["file"] = file_ else: active_file = client.file_get_active() if active_file: data["file"] = active_file["file"] if name is not None: data["name"] = name return client._creoson_post("layer", "list", data, "layers")
[docs]def show(client, name=None, file_=None, show_=None): """how/Hide one or more layers. Args: client (obj): creopyson Client. name (str, optional): Layer name (wildcards allowed: True). Defaults: All layers are listed. `file_` (str, optional): File name (wildcards allowed: True). Defaults is current active model. `show_` (boolean, optional): Whether to show or hide the layers. Defaults is True (show). Returns: None """ data = {} if file_ is not None: data["file"] = file_ else: active_file = client.file_get_active() if active_file: data["file"] = active_file["file"] if name is not None: data["name"] = name if show_ is not None: data["show"] = show_ return client._creoson_post("layer", "show", data)