create_3dcomponent#
- Modeler3D.create_3dcomponent(input_file, name=None, variables_to_include=None, assignment=None, boundaries=None, excitations=None, coordinate_systems=None, reference_coordinate_system='Global', is_encrypted=False, allow_edit=False, security_message='', password=None, edit_password=None, password_type='UserSuppliedPassword', hide_contents=False, replace_names=False, component_outline='BoundingBox', export_auxiliary=False, monitor_objects=None, datasets=None, native_components=None, create_folder=True)[source]#
Create a 3D component file.
- Parameters:
- input_file
str
Full path to the A3DCOMP file.
- name
str
,optional
Name of the component. The default is
None
.- variables_to_include
list
,optional
List of variables to include. The default is all variables.
- assignment
list
,optional
List of object names to export. The default is all object names.
- boundaries
list
,optional
List of Boundaries names to export. The default is all boundaries.
- excitations
list
,optional
List of Excitation names to export. The default is all excitations.
- coordinate_systems
list
,optional
List of Coordinate Systems to export. The default is the
reference_cs
.- reference_coordinate_system
str
,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_message
str
,optional
Security message to display when component is inserted. The default value is an empty string.
- password
str
,optional
Security password needed when adding the component. The default value is
None
.- edit_password
str
,optional
Edit password. The default value is
None
.- password_type
str
,optional
Password type. Options are
UserSuppliedPassword
andInternalPassword
. The default isUserSuppliedPassword
.- 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_outline
str
,optional
Component outline. Value can either be
BoundingBox
orNone
. The default isBoundingBox
.- export_auxiliarybool 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_objects
list
,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 toFalse
.- datasets
list
,optional
- List of dataset names to export. The default is all datasets. This argument
is relevant only if
auxiliary_dict_file
is set toTrue
.
- native_components
list
,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 toTrue
.- create_folder
Bool
,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
.
- input_file
- Returns:
- bool
True
when successful,False
when failed.
References
>>> oEditor.Create3DComponent