create_3dcomponent#

Modeler3D.create_3dcomponent(component_file, component_name=None, variables_to_include=None, object_list=None, boundaries_list=None, excitation_list=None, included_cs=None, reference_cs='Global', is_encrypted=False, allow_edit=False, security_message='', password='', edit_password='', password_type='UserSuppliedPassword', hide_contents=False, replace_names=False, component_outline='BoundingBox', auxiliary_dict=False, monitor_objects=None, datasets=None, native_components=None, create_folder=True)[source]#

Create a 3D component file.

Parameters:

component_filestr

Full path to the A3DCOMP file.

component_namestr, optional

Name of the component. The default is None.

variables_to_includelist, optional

List of variables to include. The default is all variables.

object_listlist, optional

List of object names to export. The default is all object names.

boundaries_listlist, optional

List of Boundaries names to export. The default is all boundaries.

excitation_listlist, optional

List of Excitation names to export. The default is all excitations.

included_cslist, optional

List of Coordinate Systems to export. The default is the reference_cs.

reference_csstr, optional

The Coordinate System reference. The default is "Global".

is_encryptedbool, optional

Whether the component has encrypted protection. The default is False.

allow_editbool, optional

Whether the component is editable with encrypted protection. The default is False.

security_messagestr, optional

Security message to display when component is inserted. The default value is an empty string.

passwordstr, optional

Security password needed when adding the component. The default value is an empty string.

edit_passwordstr, optional

Edit password. The default value is an empty string.

password_typestr, optional

Password type. Options are UserSuppliedPassword and InternalPassword. The default is UserSuppliedPassword.

hide_contentsbool or list, optional

List of object names to hide when the component is encrypted. If set to an empty list or False, all objects are visible.

replace_namesbool, optional

Whether to replace objects and material names. The default is False.

component_outlinestr, optional

Component outline. Value can either be BoundingBox or None. The default is BoundingBox.

auxiliary_dictbool or str, optional

Whether to export the auxiliary file containing information about defined datasets and Icepak monitor objects. A destination file can be specified using a string. The default is False.

monitor_objectslist, optional

List of monitor objects’ names to export. The default is the names of all monitor objects. This argument is relevant only if auxiliary_dict_file is not set to False.

datasetslist, optional

List of dataset names to export. The default is all datasets. This argument: is relevant only if auxiliary_dict_file is set to True.

native_componentslist, optional

List of native_components names to export. The default is all native_components. This argument is relevant only if auxiliary_dict_file is set to True.

create_folderBool, optional

If the specified path to the folder where the 3D component should be saved does not exist, then create the folder. Default is True.

Returns:

bool: True when successful, False when failed.

References

>>> oEditor.Create3DComponent