scene

Returns the selected object.
Return value :
　　shape object
Arguments :
　　int : index of the selected object : Optional if there is only one object or when getting the root object.

Resets matrices except for translation of the selected object.
Transformation elements attached to the object are preserved as-is.

Appends the memorized line object to the selected object.

Appends a meta-camera.

Appends a control point to the line object being created.
Arguments :
　　vec3 : point : position of the anchor point
Arguments :
　　vec3 : position of the in-handle
Arguments :
　　vec3 : position of the out-handle
Arguments :
　　vec3 : position of the intersecting in-handle
Arguments :
　　vec3 : the intersecting out-handle
The local coordinate system at the hierarchy where the object is created becomes the reference.
See also :
　　begin_creating()
　　begin_line()
　　end_line()
　　end_creating()

Appends an edge to a polygon mesh either being created or selected.
Arguments :
　　int : index value of one vertex of the edge
Arguments :
　　int : index value of the edge's other vertex
See also :
　　begin_creating()
　　begin_polygon_mesh()
　　end_polygon_mesh()
　　end_creating()

Generates the necessary edges for a polygon mesh without edges.

Appends a face to a polygon mesh either being created or selected.
Arguments :
　　int : list/tuple of the vertex indices
See also :
　　begin_creating()
　　begin_polygon_mesh()
　　end_polygon_mesh()
　　end_creating()

Appends a vertex to a polygon mesh either being created or selected.
Arguments :
　　vec3
The local coordinate system of the hierarchy being created or currently selected becomes the reference.
See also :
　　begin_creating()
　　begin_polygon_mesh()
　　end_polygon_mesh()
　　end_creating()

Appends a point to a TrueType (two-dimensional Bezier curve) object being created.
Arguments :
　　bool : ONポイントかどうか
Arguments :
　　float : the X coordinate value
Arguments :
　　float : the Y coordinate value
Arguments :
　　float : the Z coordinate value : optional (0 if omitted)
Call between begin_truetype() and end_truetype().
The local coordinate system at the hierarchy where the object is created becomes the reference.

Applies the memorized line object to the selected object.

Begins creation of a ball joint.
Return value :
　　part object
Arguments :
　　vec3 : center position
Arguments :
　　float : radius
Arguments :
　　string : optional　If omitted, the default name is used

It is possible to include objects created until calling end_ball_joint() inside a part.
The local coordinate system at the hierarchy where the object is created becomes the reference.

Begins creation of a bone joint.
Return value :
　　part object
Arguments :
　　vec3 : center position
Arguments :
　　float : radius
Arguments :
　　bool : Auto Align to axis
Arguments :
　　vec3 : The axis direction when doing Auto Align Axis : optional : If omitted, the default settings are applied
Arguments :
　　string : optional　If omitted, the default name is used

It is possible to include objects created until calling end_bone_joint() inside a part.
The local coordinate system at the hierarchy where the object is created becomes the reference.

Begins creation of an object.
When calling a function for creating an object, always use with end_creating().
If specifying the position of the created object, use begin_creating_at().
If omitted, Shade will process begin_creating() and end_creating() internally, slowing down the processing speed.

Begins creation of an object at the specified insertion point.
Arguments :
　　insertion_point : shape object : the shape class of the object at the insertion point
When calling a function for creating an object, always use with end_creating().

Begins creation of a custom joint.
Return value :
　　part object
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include objects created until calling end_custom_joint() inside a part.

Begins creation of a light joint.
Return value :
　　part object
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include objects created until calling end_light_effector() inside a part.

Begins creation of a line object.
Return value :
　　line object
Arguments :
　　string : optional : If omitted, the default name is used
Arguments :
　　bool : True : closed line object : False : open line object
Use together with end_line().
Create control points using append_point().
The local coordinate system at the hierarchy where the object is created becomes the reference.

Begins creation of a morph joint.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used

Begins the creation of a part.
Return value :
　　part object
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include objects created until calling end_part() inside a part.

Begins creation of a path joint.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used

Begins creation of a path replicator.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used

Begins creation of a polygon mesh.
Return value :
　　polygon_mesh object
Arguments :
　　string : optional : If "None", the default name is used
Use together with end_polygon_mesh().
Create vertices with append_polygon_mesh_vertex().
Create edges with append_polygon_mesh_edg().
The necessary faces are automatically created.
The local coordinate system at the hierarchy where the object is created becomes the reference.

Begins creation of a rotator joint.
Return value :
　　part object
Arguments :
　　vec3 : position of one end point of the axis
Arguments :
　　vec3 : position of the other end point of the axis
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include objects created until calling end_rotator_joint() inside a part.
The local coordinate system at the hierarchy where the object is created becomes the reference.

Begins creation of a scale joint.
Return value :
　　part object
Arguments :
　　vec3 : the center point
Arguments :
　　vec3 : the target point
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include objects created until calling end_scale_joint() inside a part.
The local coordinate system at the hierarchy where the object is created becomes the reference.

Begins creation of a slider joint.
Return value :
　　part object
Arguments :
　　vec3 : the starting point
Arguments :
　　vec3 : the ending point
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include objects created until calling end_slider_joint() inside a part.
The local coordinate system at the hierarchy where the object is created becomes the reference.

Begins creation of a sound object.
Return value :
　　part object
Arguments :
　　file_path
Arguments :
　　vec3 : the center point
Arguments :
　　float : radius
Arguments :
　　string : optional : If omitted, the default name is used
Use together with end_sound_object().
The local coordinate system at the hierarchy where the object is created becomes the reference.

Begins the creation of curved surface part.
Return value :
　　part object
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include line objects created until calling end_surface_part() inside a part.

Begins creation of a surface replicator.
Return value :
　　part object
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include objects created until calling end_surface_replicator() inside a part.

Begins creation of a switch.
Return value :
　　part object
Arguments :
　　string : optional  :　If omitted, the default name is used
It is possible to include objects created until calling end_switch_effector() inside a part.

Begins creation of a TrueType (two-dimensional Bezier curve) object.
Return value :
　　line object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　bool : is hole object or not
Use together with end_truetype()
Create points with append_truetype_point()

Begins creation of a uniscale joint.
Return value :
　　part object
Arguments :
　　vec3 : the center point
Arguments :
　　float : radius
Arguments :
　　string : optional  :　If omitted, the default name is used It is possible to include objects created until calling end_uniscale_joint() inside a part.
The local coordinate system at the hierarchy where the object is created becomes the reference.

Apply Bevel Edge.
Arguments :
　　float : radius

Displays the currently selected object in the Browser.

Cancels the creation of a line object.

Offsets the transformation.
Offsets the transformation on the above part.

Deletes the selected object.

Clears data memorized with the Memory tool.

Deletes the template image.

Resets the transformation.
The transformation on the object is also cleared

Closes the scene.

Closes the scene.
Arguments :
　　bool : Confirmation of scene changes : False : Close the scene without confirmation : (False) must be defined

Converts the selected object to a curved surface.

Converts the selected object to a line object.

Converts the selected object to a polygon mesh.
Arguments :
　　int : number of subdivisions in the direction of intersection
Arguments :
　　int : number of subdivisions in the direction of the selection

Copies the selected object to the clipboard.

Duplicates the object and applies rotation, scaling, or translation.
Arguments :
　　vec3 : the center point
Arguments :
　　float3 : scale
Arguments :
　　float3 : rotation
Arguments :
　　float3 : translation
See also :
　　move_object

Creates a ball joint.
Return value :
　　part object
Arguments :
　　vec3 : center position
Arguments :
　　float : radius
Arguments :
　　string : optional : If omitted, the default name is used

The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a bone joint.
Return value :
　　part object
Arguments :
　　vec3 : center position
Arguments :
　　float : radius
Arguments :
　　bool : Auto Align to axis
Arguments :
　　vec3 : The axis direction when doing Auto Align Axis : optional : If omitted, the default settings are applied
Arguments :
　　string : optional : If omitted, the default name is used

The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a camera object.
Return value :
　　part object
Arguments :
　　vec3 : the eye point
Arguments :
　　vec3 : the target point
Arguments :
　　string : optional : If omitted, the default name is used
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a custom joint.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates a disk.
Return value :
　　disk object
Arguments :
　　string : optional : If "None", the default name is used
Arguments :
　　vec3 : position
Arguments :
　　float : radius
Arguments :
　　int :

The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a light joint.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates a line object.
Return value :
　　line object
Arguments :
　　string : optional : If "None", the default name is used
Arguments :
　　vec3 tuple/list : array of control point coordinates
Arguments :
　　bool : True: closed line object, False: open line object
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a (temporary) coordinate system from the selected object.
Return value :
　　part
See also :
　　save_local_axis

Creates a master image.
Return value :
　　image object
Arguments :
　　string : optional : If "None", the default name is used
begin_creating() and end_creating() are optional.
If omitted, the Browser must be updated or the results will not take effect.

Creates a master surface.
Return value :
　　master_surface object
Arguments :
　　string : optional : If "None", the default name is used
begin_creating() and end_creating() are optional.

Creates a morph joint.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates an offset lines
Return value :
　　None
Arguments :
　　string : optional : If omitted, the default name is used
Arguments :
　　float : Distance
Arguments :
　　vec3 : Plane Coordinate : [0,1,0] : XZ-Plane、[0,0,1] : XY-Plane、[1,0,0] : ZY-Planebr /> Arguments :
　　int : Offset Direction : -1 :One-sided (Anti-clockwise), 0 : Both sides, 1 : One-sided (Clockwise)
Arguments :
　　int : Edge Style : 0 : Miter, 1 : Bevel, 2 : Round 1, 3 : Round 2
Arguments :
　　int : Roundness : -1 ~ 3.0
Arguments :
　　int : Repetition Count
Arguments :
　　int : Slope Distance : -1.0 ~ 1.0
Arguments :
　　int : Distance to : 0 : Nearest Line, 1 : Most Distant Line
Arguments :
　　float : Vertical Distance in Repetition
Arguments :
　　int : Height Distribution : -1.0 ~ 1.0
Arguments :
　　int : Height to : 0 : Nearest Line, 1 : Most Distant Line
Arguments :
　　bool : Allow to add control points : True :Yes, False :No
Arguments :
　　bool : Delete Original Shapes : True :Yes, False :No
begin_creating()、end_creating() are optional.

Creates a part.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates a path joint.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates a path replicator.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates a point light.
Return value :
　　light object
Arguments :
　　string : optional : If "None", the default name is used
Arguments :
　　vec3 : position
Arguments :
　　float : radius
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a cube.
Return value :
　　object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : object type : 0 : generic, 1 : curved surface, 2 : unused, 3 : polygon mesh
Arguments :
　　bool : UV assigned : Not valid except for polygon meshes
Arguments :
　　int : number of Ｘ direction subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of Y direction subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of Z direction subdivisions : Not valid except for polygon meshes
Arguments :
　　vec3 : coordinates of the first vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the second vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the third vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the fourth vertex composing the rectangle
Arguments :
　　vec3 : XYZ components of the height
Arguments :
　　bool : top face
Arguments :
　　bool : bottom face
The local coordinate system becomes the reference.
begin_creating() and end_creating() are optional.

Creates a capsule.
Return value :
　　object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : object type : 0 : generic, 1 : curved surface, 2 : unused, 3 : polygon mesh
Arguments :
　　bool : UV assigned : Not valid except for polygon meshes
Arguments :
　　int : number of U direction (circumference) subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of V direction (axial) subdivisions : Not valid except for polygon meshes
Arguments :
　　vec3 : the center coordinates of the lower hemisphere
Arguments :
　　float : the capsule radius
Arguments :
　　int : the crosswise plane 0 : Y Z, 1 : X Z, 2 : X Y
Arguments :
　　vec3 : XYZ components to the center of the upper hemisphere
The local coordinate system becomes the reference.
begin_creating() and end_creating() are optional.

Creates a cone.
Return value :
　　object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : object type : 0 : generic, 1 : curved surface, 2 : unused, 3 : polygon mesh
Arguments :
　　bool : UV assigned : Not valid except for polygon meshes
Arguments :
　　int : number of U direction (circumference) subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of V direction (height) subdivisions : Not valid except for polygon meshes
Arguments :
　　vec3 : the center coordinates of the bottom disk
Arguments :
　　float : the radius of the cone
Arguments :
　　int : the crosswise plane 0 : Y Z, 1 : X Z, 2 : X Y
Arguments :
　　vec3 : XYZ components of the height
Arguments :
　　bool : bottom face
The local coordinate system becomes the reference.
begin_creating() and end_creating() are optional.

Creates a cylinder.
Return value :
　　object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : object type : 0 : generic, 1 : curved surface, 2 : unused, 3 : polygon mesh
Arguments :
　　bool : UV assigned : Not valid except for polygon meshes
Arguments :
　　int : number of U direction (circumference) subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of V direction (height) subdivisions : Not valid except for polygon meshes
Arguments :
　　vec3 : the center coordinates of the bottom disk
Arguments :
　　float : the radius of the cylinder
Arguments :
　　int : the crosswise plane 0 : Y Z, 1 : X Z, 2 : X Y
Arguments :
　　vec3 : XYZ components of the height
Arguments :
　　bool : top face
Arguments :
　　bool : bottom face
The local coordinate system becomes the reference.
begin_creating() and end_creating() are optional.

Creates a rectangle.
Return value :
　　object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : object type : 0 : generic, 1 : curved surface, 2 : unused, 3 : polygon mesh
Arguments :
　　bool : UV assigned : Not valid except for polygon meshes
Arguments :
　　int : number of U direction subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of V direction subdivisions : Not valid except for polygon meshes
Arguments :
　　vec3 : coordinates of the first vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the second vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the third vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the fourth vertex composing the rectangle
The local coordinate system becomes the reference.
begin_creating() and end_creating() are optional.

Creates a triangular pyramid.
Return value :
　　object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : object type : 0 : generic, 1 : curved surface, 2 : unused, 3 : polygon mesh
Arguments :
　　bool : UV assigned : Not valid except for polygon meshes
Arguments :
　　int : number of Z direction subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of Ｘ direction subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of Y direction subdivisions : Not valid except for polygon meshes
Arguments :
　　vec3 : coordinates of the first vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the second vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the third vertex composing the rectangle
Arguments :
　　vec3 : coordinates of the fourth vertex composing the rectangle
Arguments :
　　bool : bottom face
The local coordinate system becomes the reference.
begin_creating() and end_creating() are optional.

Creates a sphere.
Return value :
　　object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : object type : 0 : generic, 1 : curved surface, 2 : unused, 3 : polygon mesh
Arguments :
　　bool : UV assigned : Not valid except for polygon meshes
Arguments :
　　int : number of U direction (circumference) subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of V direction (axial) subdivisions : Not valid except for polygon meshes
Arguments :
　　vec3 : coordinates of the center
Arguments :
　　float : the radius of the sphere
The local coordinate system becomes the reference.
begin_creating() and end_creating() are optional.

Create a 3D Text.
Return value :
　　Part Object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : Primitive Type : 0 : Default Type (Uses 0)
Arguments :
　　bool : Output UV : True :Yes, False :No (Currently is unused)
Arguments :
　　vec3 : Position 
Arguments :
　　int :Axis : 0 : YZ Plane, 1 : XZ Plane, 2 : XY Plane
Arguments :
　　int : Flip Layout : 0 : No Flip, 1 : Flip Horizontal, 2 : Flip Vertical, 3 : Flip Both Direction
Arguments :
　　vec3 : Height Vector
Arguments :
　　strings : Output Text String in UTF-8
Arguments :
　　strings : Font Name (OS X: Postscript font name; Windows: Font name)
Arguments :
　　int : Font Size
Arguments :
　　float : Character Spacing
Arguments :
　　int : Font Weight : Windows Only
Arguments :
　　bool : Italic Style : True : Yes, False : No (Windows Only)
begin_creating()、end_creating() are optional.

Creates a torus.
Return value :
　　object
Arguments :
　　string : If "None", the default name is used
Arguments :
　　int : object type : 0 : generic, 1 : curved surface, 2 : unused, 3 : polygon mesh
Arguments :
　　bool : UV assigned : Not valid except for polygon meshes
Arguments :
　　int : number of U direction (circumference) subdivisions : Not valid except for polygon meshes
Arguments :
　　int : number of V direction (axial) subdivisions : Not valid except for polygon meshes
Arguments :
　　vec3 : coordinates of the center
Arguments :
　　float : radius of the torus
Arguments :
　　float : radius of the disk that forms the torus
Arguments :
　　int : the crosswise plane 0 : Y Z, 1 : X Z, 2 : X Y
The local coordinate system becomes the reference.
begin_creating() and end_creating() are optional.

Creates a rotator joint.
Return value :
　　part object
Arguments :
　　vec3 : position of one end point of the axis
Arguments :
　　vec3 : position of the other end point of the axis
Arguments :
　　string : optional : If omitted, the default name is used
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a scale joint.
Return value :
　　part object
Arguments :
　　vec3 : the center point
Arguments :
　　vec3 : the target point
Arguments :
　　string : optional : If omitted, the default name is used
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a slider joint.
Return value :
　　part object
Arguments :
　　vec3 : the starting point
Arguments :
　　vec3 : the ending point
Arguments :
　　string : optional : If omitted, the default name is used
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a sound object.
Return value :
　　part object
Arguments :
　　file_path
Arguments :
　　vec3 : the center point
Arguments :
　　float : radius
Arguments :
　　string : optional : If omitted, the default name is used
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a sphere.
Return value :
　　sphere object
Arguments :
　　string : optional : If "None", the default name is used
Arguments :
　　vec3 : position
Arguments :
　　float : radius
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a spotlight.
Return value :
　　light object
Arguments :
　　string : optional : If "None", the default name is used
Arguments :
　　vec3 : position of the light
Arguments :
　　vec3 : the target position
Arguments :
　　float : the intensity
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Creates a curved surface part.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates a surface replicator.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates a switch.
Return value :
　　part object
Arguments :
　　string : optional : If omitted, the default name is used
begin_creating() and end_creating() are optional.

Creates a uniscale joint.
Return value :
　　part object
Arguments :
　　vec3 : the center point
Arguments :
　　float : radius
Arguments :
　　string : optional : If omitted, the default name is used
The local coordinate system at the hierarchy where the object is created becomes the reference.
begin_creating() and end_creating() are optional.

Cuts the selected object to the clipboard.

Degenerates to a point.

Deselects all motion points.

Draws the Figure Window.

Ends creation of a ball joint.
Use after begin_ball_joint() to stop creating the ball joint. Always use as a set.

Ends creation of a bone joint.
Use after begin_bone_joint() to stop creating the bone joint. Always use as a set.

Ends creation of an object
Use after begin_creating() to stop creating the object.
Always use as a set.

Ends creation of a custom joint.
Call after begin_custom_joint() to stop creating the custom joint.
Always use as a set.

Ends creation of a light joint.
Call after begin_light_effector() to stop creating the light joint.
Always use as a set.

Ends creation of a line object.
Call after begin_line() to stop creating the line object.
Always use as a set.

Ends creation of a morph joint.
Call after begin_morph_effector() to stop creating the morph joint.
Always use as a set.

Ends creation of a part.
Call after begin_part() to stop creating the part.
Always use as a set.

Ends creation of a path joint.
Call after begin_path_joint() to stop creating the path joint.
Always use as a set.

Ends creation of a path replicator.
Call after begin_path_replicator() to stop creating the path replicator.
Always use as a set.

Ends creation of a polygon mesh.
Call after #begin_polygon_mesh｜begin_polygon_mesh() to stop creating the polygon mesh.
Always use as a set.

Ends creation of a rotator joint.
Call after begin_rotator_joint() to stop creating the rotator joint.
Always use as a set.

Ends creation of a scale joint.
Call after begin_scale_joint() to stop creating the scale joint.
Always use as a set.

Ends creation of a slider joint.
Call after begin_slider_joint() to stop creating the slider joint.
Always use as a set.

Ends creation of a sound object.
Call after begin_sound_object() to stop creating the sound object.
Always use as a set.

Ends creation of a curved surface part.
Call after begin_surface_part() to stop creating the curved surface part.
Always use as a set.

Ends creation of a surface replicator.
Call after begin_surface_replicator() to stop creating the surface replicator part.
Always use as a set.

Ends creation of a switch.
Call after begin_switch_effector() to stop creating the switch.
Always use as a set.

Ends creation of a TrueType (two-dimensional Bezier curve) object.
Call after begin_truetype() to stop creating the TrueType object.
Always use as a set.

Ends creation of a uniscale joint.
Call after begin_uniscale_joint() to stop creating the uniscale joint.
Always use as a set.

Enters Create Line Mode.
Arguments :
　　bool : True : closed line object, False : open line object
See also :
　　is_create_line_mode()　Whether in Create Line Mode or not
　　exit_create_line_mode()　Exits Create Line Mode

Enters Modify Mode.
See also :
　　is_modify_mode()　Whether in Modify Mode or not
　　exit_modify_mode()　Exits Modify Mode

Exits Create Line Mode.
See also :
　　enter_create_line_mode()　Enters Create Line Mode

Exits Modify Mode.
See also :
　　is_modify_mode()　Whether in Modify Mode or not
　　enter_modify_mode()　Enters Modify Mode

Exports the scene data
Arguments :
　　file_path
Arguments :
　　int :

Exports the file with uuid.
Arguments :
　　uuid: 128 bit value
Arguments :
　　file_path
See also :
　　uuid

Fits object to the Figure Window.
Type :
　　key : optional : If omitted, fits the whole scene, 0x01 : Fits the selected object

In Modify Mode, flips between hidden and nonhidden faces.

Forces a screen redraw.

Returns the grid on/off value of the specified viewport.
Return value :
　　bool
Arguments :
　　int : view index

See also :
　　set_grid_shown

Gets the IK handling class.
Return value :
　　ik object

Returns an object with the specified name.
Return value :
　　shape object
Arguments :
　　string : the object name
Arguments :
　　bool : False : only valid for names set by the user, True : also valid for default names

Returns an object specified by ordinal number.
Return value :
　　shape object
Arguments :
　　int : ordinal number
Ordinals are determined by their order in the Brower, with the root part as 0.
See also :
　　shape.ordinal

Returns an object by position in the Browser.
Return value :
　　shape object
Arguments :
　　int tuple/list  : list of positions
With the root part as the top of the hierarchy, classify the following in list format, and get the object using that hierarchical list.

Returns an object specified by uuid.
Arguments :
　　uuid : 128 bit value
Return value :
　　shape object
See also :
　　uuid

Returns a tuple of objects with the specified name.
Return value :
　　shape object tuple
Arguments :
　　string : the object name
Arguments :
　　bool : False : only valid for names set by the user, True : also valid for default names

Returns the rectangular display area of the view specified by argument.
Return value :
　　rectangle
Arguments :
　　int : view index

Hides the selected object.

Hides unselected objects.

In Modify Mode, hides the selected faces of the selected object.

In Modify Mode, hides the unselected faces of the selected object.

Applies Iron

Links the selected part to the memorized object.

Creates a link object referencing the selected object.
Arguments :
　　vec3 : the center point
Arguments :
　　float3 : scale
Arguments :
　　float3 : rotation
Arguments :
　　float3 : translation
The local coordinate system at the hierarchy where the object is created becomes the reference.

Imports a 3DS file.
Arguments :
　　file_path : extension (*.3ds) : If "None", opens a file dialog.
See also :
　　save_3DS

Imports a BVH file.
Arguments :
　　file_path : extension (*.bvh) : If "None", opens a file dialog.

Imports a DXF file.
Arguments :
　　file_path : extension (*.dxf) : If "None", opens a file dialog.
See also :
　　save_DXF

Imports a wavefront OBJ file.
Arguments :
　　file_path : extension (*.obj) : If "None", opens a file dialog.
See also :
　　save_OBJ

Imports a Shade Pose file.
Arguments :
　　file_path : extension (*.shdpse) : If "None", opens a file dialog.
See also :
　　save_pose

Imports Shade object data.
Arguments :
　　file_path : extension (*.shd) : If "None", opens a file dialog.
Arguments :
　　bool : Optional (required if vec3 is specified)
　　True : Imports the scene using the origin of the imported scene as the reference point. Equivalent to the operation done while Option (Mac) or z (Win) is held.
　　False : Imports the scene using the cursor position of the imported scene as the reference point.
Arguments :
　　vec3 : coordinates of the import reference point : optional
See also :
　　save_shape

Loads a template in the bottom left viewport.
Arguments :
　　file_path

Loads a template in the top right viewport.
Arguments :
　　file_path

Loads a template in the bottom right viewport.
Arguments :
　　file_path

Loads a template in the top left viewport.
Arguments :
　　file_path

Imports an XML text file.
Arguments :
　　file_path : extension (*.xmlshd) : If "None", opens a file dialog.
See also :
　　save_text

Magnifies the Figure Window.
Arguments :
　　vec3 : center position : optional : If omitted, the origin is used

Returns the memorized object.
Return value :
　　shape object : the memorized object

Memorizes the selected line object.

Applies rotation, scaling, or translation to an object.
Arguments :
　　vec3 : the center point
Arguments :
　　float3 : scale
Arguments :
　　float3 : rotation
Arguments :
　　float3 : translation
See also :
　　copy_object

Pastes an object into the scene from the clipboard.

Moves the selected object down.
Arguments :
　　int : the number to move

Moves the selected object inside the below part.
Arguments :
　　int : the number of (child) parts in the hierarchy to move

Moves the selected object to the top of the above hierarchy level.
Arguments :
　　int : the number of hierarchy levels to move

Moves the selected object forward.
Arguments :
　　int : the number to move

Prints the rendered image.

Loads a scene from file.
Arguments :
　　file_path
Abandons the current scene and loads a scene (does not import it).

Applies Repeat.
Arguments :
　　int : repetitions : If omitted, 1
Only valid for move and copy operations.

Resets the matrices of all parts within the selected part to unit matrices.
The object's morph state is not changed.

Resets the matrix of the selected part to a unit matrix.
The object's morph state is not changed.

Applies Reverse.

Reverts the open Shade file to the saved state.

Applies Round Edge.
Arguments :
　　float : radius

Saves over the current scene.
If a new object, a file dialog is displayed.
See also :
　　xshade.open_scene()

Exports as a 3DS file.
Arguments :
　　file_path : extension (*.3ds) : If "None", opens a file dialog.
See also :
　　load_3DS

Exports as an Animation:Master segment file.
Arguments :
　　file_path : extension (*.seg) : If "None", opens a file dialog.

Displays a file dialog and saves the scene to file.

Exports as a DXF file.
Arguments :
　　file_path : extension (*.dxf) : If "None", opens a file dialog.
See also :
　　load_DXF

Exports as an EPix file.
Arguments :
　　file_path
It is necessary to specify both the Z Depth and object ID (or surface ID) passes with MultiPass and render ahead of time.
See also :
　　multipass_rendering　Keep MultiPass on/off
　　set_image_layer_enable　Layers on/off

Exports as an FBX file.
Arguments :
　　file_path : extension (*.fbx) : If "None", opens a file dialog.

Saves the rendered image to file.
Arguments :
　　file_path
Specify the image format via the extension.

Saves the rendered image to file in multi-layer format.
Arguments :
　　file_path
It is necessary to render in multi-layer format ahead of time.

Saves the coordinate system (used temporarily).
Return value :
　　part
See also :
　　create_local_axis

Exports as a wavefront OBJ file.
Arguments :
　　file_path : extension (*.obj) : If "None", opens a file dialog.
See also :
　　load_OBJ

Exports a pose file.
Arguments :
　　file_path : extension (*.shdpse) : If "None", opens a file dialog.
See also :
　　load_pose

Exports as a RIB file.
Arguments :
　　file_path : extension (*.rib) : If "None", opens a file dialog.

Exports as a Shade Shape file.
Arguments :
　　file_path : extension (*.shd) : If "None", opens a file dialog.
See also :
　　load_shape

Exports as an XML text file.
Arguments :
　　file_path
See also :
　　load_text

Exports as a VRML file.
Arguments :
　　file_path : extension (*.wrl) : If "None", opens a file dialog.

Displays a file dialog and exports as a VRML file.

Scrolls the Figure Window.
Arguments :
　　vec3 : center position

Selects the root object in Object Mode.
In Modify Mode, selects all the control points of the selected object.

Selects the object after the selected object.
Return value :
　　bool
Arguments :
　　int : the number of objects after : optional : If omitted, 1

Selects the objects in the part below the selected object.
Return value :
　　bool
Arguments :

Selects the part above the selected object in the hierarchy.
Return value :
　　bool
Arguments :
　　int : the number of hierarchy levels above : optional : If omitted, 1

Selects the object before the selected object.
Return value :
　　bool
Arguments :
　　int : the number of objects before : optional : If omitted, 1

Returns a matrix that converts the world coordinate system of the specified sequence to device coordinates.
Arguments :
　　int
Return value :
　　mat4

Returns a matrix that converts the world coordinate system of the specified sequence to perspective coordinates.
Arguments :
　　int
Return value :
　　mat4

Returns a matrix that converts the world coordinate system of the specified sequence to view coordinates.
Arguments :
　　int
Return value :
　　mat4

Sets the grid on/off value of the specified viewport.
Arguments :
　　int : view index

Arguments :
　　bool
See also :
　　get_grid_shown

Displays the selected object.

Displays all objects

In Modify Mode, displays all the faces of the selected object.

Shrinks the Figure Window.
Arguments :
　　vec3 : center position : optional

Applies Smooth.

Returns the original state of an extruded or revolved solid.

Creates an extruded solid.
Arguments :
　　float3 : vector of the extruded distance

Creates a revolved solid.
Arguments :
　　vec3 : one end point of the axis of revolution
Arguments :
　　vec3 : the other end point of the axis of revolution

Applies Sweep.

Applies Switch.

Applies Unsmooth.

Redraws the Figure Window.

Uses global coordinates for the Figure Window display.

Uses the local coordinates of the selected object for the Figure Window display.

Uses the specified coordinate system.
Arguments :
　　string

Saves a Shade scene file.
Arguments :
　　file_path : extension (*.shd) : If "None", opens a file dialog.

Saves a Shade scene file after adding compatibility information.
Arguments :
　　file_path

Saves a Shade scene file without adding compatibility information.
Arguments :
　　file_path

Saves a Shade scene file after adding R4 compatibility information.
Arguments :
　　file_path

Saves a Shade scene file as XML.
Arguments :
　　file_path

The list of currently selected objects.

• Get
• Set

Type :
　　shape object

Animation of the scene.

• Get
• Set

Type :
　　animation_settings object
See also :
　　animation_settings

Background of the scene.

• Get
• Set

Type :
　　background object
See also :
　　background

The currently selected camera in the scene.

• Get
• Set

Type :
　　camera object
See also :
　　camera

Whether or not there is a functional restriction on creating new objects.

• Get
• Set

Type :
　　bool : True is the normal value.

Whether or not there is a functional restriction on exporting to formats unrelated to Shade.

• Get
• Set

Type :
　　bool : True is the normal value.

Whether or not there is a functional restriction on exporting to Shade-related formats.

• Get
• Set

Type :
　　bool : True is the normal value.

Whether or not there is a functional restriction on saving the scene.

• Get
• Set

Type :
　　bool : True is the normal value.

Whether or not there is a functional restriction on saving the rendered image to file.

• Get
• Set

Type :
　　bool : True is the normal value.

The coordinates of the center of each of the viewports, other than the perspective view.

• Get
• Set

Type :
　　vec3

Color mode of the Figure Window display.

• Get
• Set

Type :
　　bool

Color correction of the scene.

• Get
• Set

Type :
　　correction object
See also :
　　correction

The index value of the currently selected camera.

• Get
• Set

Type :
　　int

Current coordinates value of the 3D cursor in the Figure Window.

• Get
• Set

Type :
　　vec3

The cursor plane in the perspective view.

• Get
• Set

Type :
　　int : 0 : YZ, 1 : XZ, 2 : XY, 3 : screen

Coordinates value of the 3D cursor in the Figure Window (the clicked position).

• Get
• Set

Type :
　　vec3

Default value of Round Edge and Bevel Edge.

• Get
• Set

Type :
　　float

Default radius of a disk.

• Get
• Set

Type :
　　float

Default light intensity.

• Get
• Set

Type :
　　float

Default radius of Round Edge and Bevel Edge for line objects.

• Get
• Set

Type :
　　float

Default radius of a sphere.

• Get
• Set

Type :
　　float

Whether or not the scene is dirty.

• Get
• Set

Type :
　　bool
The scene is dirty if any operation is done in an open scene.
When closing dirty scenes a dialog is displayed asking, "Do you want to save the changes ...?"

Figure Window of the scene.

• Get
• Set

Type :
　　display object
See also :
　　display

Distant Light of the scene.

• Get
• Set

Type :
　　distant_light object
See also :
　　distant_light

Figure Window view mode.

• Get
• Set

Type :
　　int : view index

Figure Window of the scene.

• Get
• Set

Type :
　　figure_window object
See also :
　　figure_window

File path of the saved scene.

• Get
• Set

Type :
　　file_path

Distant Light Fog of the scene.

• Get
• Set

Type :
　　fog object
See also :
　　fog

Scene fps.

• Get
• Set

Type :
　　int

Grid display on/off.

• Get
• Set

Type :
　　bool

Shape class of the object at the inserted position when creating an object with begin_creating().

• Get
• Set

Type :
　　shape object

Whether or not in Create Line Mode.

• Get
• Set

Type :
　　bool

Whether or not the file is locked.

• Get
• Set

Type :
　　bool

Whether or not in Modify Mode.

• Get
• Set

Type :
　　bool

Whether or not the Motion Window is playing

• Get
• Set

Type :
　　bool

Keyframes of the scene.

• Get
• Set

Type :
　　keyframes object
See also :
　　keyframes

Large Cursor display on/off.

• Get
• Set

Type :
　　bool

Large Point display on/off

• Get
• Set

Type :
　　bool

Lathe rotation.

• Get
• Set

Type :
　　quaternion

Light scale.

• Get
• Set

Type :
　　float

Reference part of the local coordinates.

• Get
• Set

Type :
　　shape object
Getting is possible in local mode

Local coordinates mode transformation matrix.

• Get
• Set

Type :
　　mat4

The manipulator type.

• Get
• Set

Type :
　　int : 0: none, 1: Universal, 2: Translate, 3: Scale, 4: Rotate

Whether or not in Mapping Modify Mode.

• Get
• Set

Type :
　　bool

Coefficient which converts native units (mm) to user-defined units.

• Get
• Set

Type :
　　float
See also :
　　user_to_native_unit

The number of control points of the line object being created.

• Get
• Set

Type :
　　int

The number of cameras.

• Get
• Set

Type :
　　int

The number of memorized objects.

• Get
• Set

Type :
　　int
Returns 1 if there are memorized objects, 0 if there are none.

The number of meta-cameras.

• Get
• Set

Type :
　　int

Perspective Grid display on/off.

• Get
• Set

Type :
　　bool

The pivot coordinates.

• Get
• Set

Type :
　　vec3

The state of magnification of the Figure Window.

• Get
• Set

Type :
　　int : 1 dot is 10
Returns the size in the scene of 1 pixel of the display.
The width of one square of the Minor Grid will be 10 times this.

Radiosity of the scene.

• Get
• Set

Type :
　　radiosity object
See also :
　　radiosity

Rendering of the scene.

• Get
• Set

Type :
　　rendering object
See also :
　　rendering

The Toolbox Selection Mode.

• Get
• Set

Type :
　　int :

Reflect changes using tool_box_view().update()

The Mesh Selection Mode.

• Get
• Set

Type :
　　int :

Whether the scene is in Sequence Mode or not.

• Get
• Set

Type :
　　bool

The sequence value of the Motion Window.

• Get
• Set

Type :
　　float

The root object.

• Get
• Set

Type :
　　shape object
See also :
　　shape

Whether to show normals or not

• Get
• Set

Type :
　　bool

Snap on/off.

• Get
• Set

Type :
　　bool

The number of step frames of the animation (float).

• Get
• Set

Type :
　　float

Template display on/off.

• Get
• Set

Type :
　　bool

The unit value.

• Get
• Set

Type :
　　int :

Coefficient which converts user-defined units to native units (mm).

• Get
• Set

Type :
　　float
See also :
　　native_to_user_unit

Matrix that converts the user coordinate system to world coordinates.

• Get
• Set

Type :
　　mat4
The user coordinate system is the coordinate system of the Figure Window display, taking into account rotation and Local or Global Mode.
It is used such as when taking into account the movement or rotation of an object.
See also :
　　world_to_user_matrix

The Figure Window frame.
Type :
　　rectangle

Work plane on/off.

• Get
• Set

Type :
　　bool

Matrix that converts the world coordinate system to device coordinates.

• Get
• Set

Type :
　　mat4
A matrix which rotates, translates, and normalizes the world coordinates based on the camera position, direction, and bank.
Moves the eye point to the origin and aligns the line of sight with the Z axis.
The device coordinate system normalizes the X and Y coordinates to match the X and Y positions of the rendered image (representing the field of view), as measured in pixels from the top left of the rendered image.

Matrix that converts the world coordinate system to the perspective coordinate system of the active camera.

• Get
• Set

Type :
　　mat4
A matrix which rotates, translates, and normalizes the world coordinates based on the camera position, direction, and bank.
Moves the eye point to the origin and aligns the line of sight with the Z axis.
Normalizes the coordinates in the field of view to fit within -1.0 and 1.0 vertically and horizontally, and within 0.0 and 1.0 in depth. Because coordinates outside this range are outside the field of view, clipping will be performed on those coordinates.

Matrix that converts the world coordinate system to user coordinates.

• Get
• Set

Type :
　　mat4
The user coordinate system is the coordinate system of the Figure Window display, taking into account the units, rotation of the object and Local or Global Mode. It is used such as when taking into account the movement or rotation of an object.
See also :
　　user_to_world_matrix

Matrix that converts the world coordinate system to the view coordinate system of the active camera.

• Get
• Set

Type :
　　mat4
Applies a matrix with eye point at the origin which rotates and translates the world coordinates based on the camera position, direction, and bank, and aligns the line of sight with the Z axis.
Perspective transformation is not done.