Python Integration - Revision history

Shatch: /* impenetrable_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma) */

2015-12-04T16:29:18Z

‎impenetrable_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma)

Shatch: /* Material Group Functions */

2015-12-04T16:28:52Z

‎Material Group Functions

Shatch: /* Material Group Functions */

2015-12-04T16:20:58Z

‎Material Group Functions

Shatch: /* Material Group Functions */

2015-12-04T15:52:06Z

‎Material Group Functions

Shatch: /* Material Group Functions */

2015-12-04T15:51:23Z

‎Material Group Functions

Shatch: /* Material Group Functions */

2015-12-04T15:44:46Z

‎Material Group Functions

Shatch: /* Material Group Functions */

2015-12-04T15:41:15Z

‎Material Group Functions

Shatch: /* extrude({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} nturns, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer) */

2015-12-02T18:25:38Z

‎extrude({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} nturns, {{ArgTypeAny}} radius_inner, {{ArgTypeAny}} radius_outer)

Shatch: /* Transform Functions */

2015-12-02T18:14:59Z

‎Transform Functions

Shatch at 18:04, 2 December 2015

2015-12-02T18:04:47Z

@@ Line 211: / Line 211: @@
 Description:  Creates a Penetrable material group in [[EM.Terrano]]. If a Penetrable group 'label' already exists, the group is activated.
-====impenetrable_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma)====
+====impenetrable_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma)====
 ''Example:impenetrable_group("Impenet_1",2.2,.0001)''

@@ Line 181: / Line 181: @@
 Description:  Creates a PMC material group in the current module. If a PMC group 'label' already exists, the group is activated.
-====dielectric_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)====
+====dielectric_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)====
 ''Example:dielectric_group("Dielectric_1","my_eps",0,1,0)''
@@ Line 205: / Line 205: @@
 Description:  Creates a Color group in [[CubeCAD]] module.  If a Color group 'label' already exists, the group is activated.
-====penetrable_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)====
+====penetrable_group({{ArgTypeString}} label, {{ArgTypeAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)====
 ''Example:penetrable_group("Impenet_1",2.2,.0001, 1)''

@@ Line 183: / Line 183: @@
 ====dielectric_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)====
-''Example:dielectric_group("PEC_1","my_eps",0,1,0)''
+''Example:dielectric_group("Dielectric_1","my_eps",0,1,0)''
 Description:  Creates a Dielectric material group in the current module with the specified material properties.  If a Dielectric group 'label' already exists, the group is activated.
@@ Line 189: / Line 189: @@
 ====thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius)====
-''Example:thinwire_group("PEC_1",4)''
+''Example:thinwire_group("Thinwire_1",4)''
 Description:  Creates a Thinwire material group in the current module.   If a Thinwire group 'label' already exists, the group is activated.
-====pec_group({{ArgTypeString}} label)====
+====base_point_group({{ArgTypeString}} label)====
-''Example:pec_group("PEC_1")''
+''Example:base_point_set("BP_Set_1")''
-Description:  Creates a PEC material group in the current module.
+Description:  Creates a Base Point Set in [[EM.Terrano]].   If a Base Point Set group 'label' already exists, the group is activated.
-====pec_group({{ArgTypeString}} label)====
+====color_group({{ArgTypeString}} label)====
-''Example:pec_group("PEC_1")''
+''Example:color_group("Color_1")''
-Description:  Creates a PEC material group in the current module.
+Description:  Creates a Color group in [[CubeCAD]] module.  If a Color group 'label' already exists, the group is activated.
-====pec_group({{ArgTypeString}} label)====
+====penetrable_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} thickness)====
-''Example:pec_group("PEC_1")''
+''Example:penetrable_group("Impenet_1",2.2,.0001, 1)''
-Description:  Creates a PEC material group in the current module.
+Description:  Creates a Penetrable material group in [[EM.Terrano]]. If a Penetrable group 'label' already exists, the group is activated.
-====pec_group({{ArgTypeString}} label)====
+====impenetrable_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma)====
-''Example:pec_group("PEC_1")''
+''Example:impenetrable_group("Impenet_1",2.2,.0001)''
-Description:  Creates a PEC material group in the current module.====explode({{ArgTypeString}} object)====
+Description:  Creates a Impenetrable material group in [[EM.Terrano]]. If an Impenetrable group 'label' already exists, the group is activated.
-−
-''Example:explode("MyArray")''
-−
-Description:  Performs an explode operation on a CAD object named 'object'.
-−
-====revolve({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} rot_angle)====
-−
-''Example:revolve("Rev1","Line_1",0,0,0,0,0,1)''
-−
-Description:  Creates or modifies a Revolution object called 'label', with a primitive object named 'object'.  If modifying an existing Revolution object, 'object' is ignored, and the pre-existing primitive object is used. (x0,y0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. rot_angle is in degrees.
 ==Simulation Setup and Meshing Functions==

@@ Line 181: / Line 181: @@
 Description:  Creates a PMC material group in the current module. If a PMC group 'label' already exists, the group is activated.
-====dielectric_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgStringAny}} sigma, {{ArgStringAny}} mu, {{ArgStringAny}} rho)====
+====dielectric_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgTypeAny}} sigma, {{ArgTypeAny}} mu, {{ArgTypeAny}} rho)====
 ''Example:dielectric_group("PEC_1","my_eps",0,1,0)''
@@ Line 187: / Line 187: @@
 Description:  Creates a Dielectric material group in the current module with the specified material properties.  If a Dielectric group 'label' already exists, the group is activated.
-====thinwire_group({{ArgTypeString}} label, {{ArgStringAny}} radius)====
+====thinwire_group({{ArgTypeString}} label, {{ArgTypeAny}} radius)====
 ''Example:thinwire_group("PEC_1",4)''

@@ Line 173: / Line 173: @@
 ''Example:pec_group("PEC_1")''
-Description:  Creates a PEC material group in the current module.
+Description:  Creates a PEC material group in the current module.  If a PEC group 'label' already exists, the group is activated.
-====union({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)====
+====pmc_group({{ArgTypeString}} label)====
-''Example:union("Union_Object","Rect_Strip1","Rect_Strip2")''
+''Example:pmc_group("PMC_1")''
-Description:  Creates a Boolean object named 'label' by unioning object_1 and object_2.  An error will be thrown if a Boolean object named 'label' already exists.
+Description:  Creates a PMC material group in the current module. If a PMC group 'label' already exists, the group is activated.
-====intersect({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)====
+====dielectric_group({{ArgTypeString}} label, {{ArgStringAny}} eps, {{ArgStringAny}} sigma, {{ArgStringAny}} mu, {{ArgStringAny}} rho)====
-''Example:intersect("Intersection_Object","Rect_Strip1","Rect_Strip2")''
+''Example:dielectric_group("PEC_1","my_eps",0,1,0)''
-Description:  Creates a Boolean object named 'label' by intersecting object_1 and object_2.  An error will be thrown if a Boolean object named 'label' already exists.
+Description:  Creates a Dielectric material group in the current module with the specified material properties.  If a Dielectric group 'label' already exists, the group is activated.
-====array({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing)====
+====thinwire_group({{ArgTypeString}} label, {{ArgStringAny}} radius)====
-''Example:array("Array_1","Rect_Strip_1",4,4,1,"spacing","spacing",0)''
+''Example:thinwire_group("PEC_1",4)''
-Description:  Create or modify an Array object.
+Description:  Creates a Thinwire material group in the current module.   If a Thinwire group 'label' already exists, the group is activated.
-====translate_by({{ArgTypeString}} label,  {{ArgTypeReal}} x_dist, {{ArgTypeReal}} y_dist, {{ArgTypeReal}} z_dist)====
+====pec_group({{ArgTypeString}} label)====
-''Example:translate_by("MyObj",10,10,x)''
+''Example:pec_group("PEC_1")''
-Description:  Translates an object by the specified distances in each direction.
+Description:  Creates a PEC material group in the current module.
-====translate_to({{ArgTypeString}} label,  {{ArgTypeReal}} x_dest, {{ArgTypeReal}} y_dest, {{ArgTypeReal}} z_dest)====
+====pec_group({{ArgTypeString}} label)====
-''Example:translate_to("MyObj",20,20,x2)''
+''Example:pec_group("PEC_1")''
-Description:  Translates an object to the specified destination.
+Description:  Creates a PEC material group in the current module.
-====rotate({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle)====
+====pec_group({{ArgTypeString}} label)====
-''Example:rotate("pyramid_1",0,0,0,10,10,100)''
+''Example:pec_group("PEC_1")''
-Description:  Draws a circular curve object in the scene under the currently activated Material Group node, or modifies a Circle object if Circle 'label' already exists. The parameters start_angle and end_angle are in degrees.
+Description:  Creates a PEC material group in the current module.
-−
-====extrude({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} height)====
-''Example:extrude("Extrude_Object","Rect_Strip1",50)''
+====pec_group({{ArgTypeString}} label)====
-Description:  Creates or modifies an Extrusion object from CAD object 'object'.  If modifying an existing extrusion, 'object' is ignored, and the pre-existing primitive is used.  extrude(...) can only extrude objects that have a single face, and will extrude in the direction of the face's normal.
+''Example:pec_group("PEC_1")''
-====explode({{ArgTypeString}} object)====
+Description:  Creates a PEC material group in the current module.====explode({{ArgTypeString}} object)====
 ''Example:explode("MyArray")''

← Older revision		Revision as of 15:41, 4 December 2015
Line 168:		Line 168:

	==Material Group Functions==		==Material Group Functions==
		+
		+	====pec_group({{ArgTypeString}} label)====
		+
		+	''Example:pec_group("Subtract_Object","Rect_Strip1","Rect_Strip2")''
		+
		+	Description: Creates a Boolean object named 'label' by subtracting object_2 from object_1. An error will be thrown if a Boolean object named 'label' already exists.
		+
		+	====union({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)====
		+
		+	''Example:union("Union_Object","Rect_Strip1","Rect_Strip2")''
		+
		+	Description: Creates a Boolean object named 'label' by unioning object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.
		+
		+	====intersect({{ArgTypeString}} label, {{ArgTypeString}} object_1, {{ArgTypeString}} object_2)====
		+
		+	''Example:intersect("Intersection_Object","Rect_Strip1","Rect_Strip2")''
		+
		+	Description: Creates a Boolean object named 'label' by intersecting object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.
		+
		+	====array({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x_count, {{ArgTypeAny}} y_count, {{ArgTypeAny}} z_count, {{ArgTypeAny}} x_spacing, {{ArgTypeAny}} y_spacing, {{ArgTypeAny}} z_spacing)====
		+
		+	''Example:array("Array_1","Rect_Strip_1",4,4,1,"spacing","spacing",0)''
		+
		+	Description: Create or modify an Array object.
		+
		+	====translate_by({{ArgTypeString}} label, {{ArgTypeReal}} x_dist, {{ArgTypeReal}} y_dist, {{ArgTypeReal}} z_dist)====
		+
		+	''Example:translate_by("MyObj",10,10,x)''
		+
		+	Description: Translates an object by the specified distances in each direction.
		+
		+	====translate_to({{ArgTypeString}} label, {{ArgTypeReal}} x_dest, {{ArgTypeReal}} y_dest, {{ArgTypeReal}} z_dest)====
		+
		+	''Example:translate_to("MyObj",20,20,x2)''
		+
		+	Description: Translates an object to the specified destination.
		+
		+	====rotate({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle)====
		+
		+	''Example:rotate("pyramid_1",0,0,0,10,10,100)''
		+
		+	Description: Draws a circular curve object in the scene under the currently activated Material Group node, or modifies a Circle object if Circle 'label' already exists. The parameters start_angle and end_angle are in degrees.
		+
		+	====extrude({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} height)====
		+
		+	''Example:extrude("Extrude_Object","Rect_Strip1",50)''
		+
		+	Description: Creates or modifies an Extrusion object from CAD object 'object'. If modifying an existing extrusion, 'object' is ignored, and the pre-existing primitive is used. extrude(...) can only extrude objects that have a single face, and will extrude in the direction of the face's normal.
		+
		+	====explode({{ArgTypeString}} object)====
		+
		+	''Example:explode("MyArray")''
		+
		+	Description: Performs an explode operation on a CAD object named 'object'.
		+
		+	====revolve({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} rot_angle)====
		+
		+	''Example:revolve("Rev1","Line_1",0,0,0,0,0,1)''
		+
		+	Description: Creates or modifies a Revolution object called 'label', with a primitive object named 'object'. If modifying an existing Revolution object, 'object' is ignored, and the pre-existing primitive object is used. (x0,y0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. rot_angle is in degrees.

	==Simulation Setup and Meshing Functions==		==Simulation Setup and Meshing Functions==

@@ Line 125: / Line 125: @@
 Description:  Create or modify an Array object.
-====translate_by({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)====
+====translate_by({{ArgTypeString}} label,  {{ArgTypeReal}} x_dist, {{ArgTypeReal}} y_dist, {{ArgTypeReal}} z_dist)====
-''Example:translate_by("pl_1",(0,0,0),(1,0,0),(1,0,0))''
+''Example:translate_by("MyObj",10,10,x)''
-Description:  Creates or modifies a PolyLine object in the scene. Each point is represented with a Python tuple type. The poly_line is closed if p0 is specified again as pn, otherwise, it is open.
+Description:  Translates an object by the specified distances in each direction.
-====translate_to({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)====
+====translate_to({{ArgTypeString}} label,  {{ArgTypeReal}} x_dest, {{ArgTypeReal}} y_dest, {{ArgTypeReal}} z_dest)====
-''Example:translate_to("nc_1",(0,0,0),(1,0,0),(1,0,0))''
+''Example:translate_to("MyObj",20,20,x2)''
-Description:  Creates or modifies a NURBS Curve object in the scene. Each point is represented with a Python tuple type.  The curve is closed if p0 is specified again as pn, otherwise, it is open.
+Description:  Translates an object to the specified destination.
 ====rotate({{ArgTypeString}} label, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} radius, {{ArgTypeAny}} start_angle, {{ArgTypeAny}} end_angle)====
@@ Line 149: / Line 149: @@
 Description:  Draws a helical curve in the scene under the currently activated Material Group node, or modifies a Helix if Helix 'label' already exists. radius_inner specifies the helix's radius at the beginning of the helix, and radius_outer specifies the radius at the end of the helix.
-====explode({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)====
+====explode({{ArgTypeString}} object)====
-''Example:explode("pl_1",(0,0,0),(1,0,0),(1,0,0))''
+''Example:explode("MyArray")''
-Description:  Creates or modifies a PolyLine object in the scene. Each point is represented with a Python tuple type. The poly_line is closed if p0 is specified again as pn, otherwise, it is open.
+Description:  Performs an explode operation on a CAD object named 'object'.
-====revolve({{ArgTypeString}} label, {{ArgType| 3x1 Python tuple}} p0, {{ArgType| 3x1 Python tuple}} p1, ... {{ArgType| 3x1 Python tuple}} pn)====
+====revolve({{ArgTypeString}} label, {{ArgTypeString}} object, {{ArgTypeAny}} x0, {{ArgTypeAny}} y0, {{ArgTypeAny}} z0, {{ArgTypeAny}} uX, {{ArgTypeAny}} uY, {{ArgTypeAny}} uZ, {{ArgTypeAny}} rot_angle)====
-''Example:revolve("nc_1",(0,0,0),(1,0,0),(1,0,0))''
+''Example:revolve("Rev1","Line_1",0,0,0,0,0,1)''
-Description:  Creates or modifies a NURBS Curve object in the scene. Each point is represented with a Python tuple type.  The curve is closed if p0 is specified again as pn, otherwise, it is open.
+Description:  Creates or modifies a Revolution object called 'label', with a primitive object named 'object'.  If modifying an existing Revolution object, 'object' is ignored, and the pre-existing primitive object is used. (x0,y0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. rot_angle is in degrees.
 ==Source Functions==

← Older revision		Revision as of 18:04, 2 December 2015
Line 165:		Line 165:

	==Result Functions==		==Result Functions==
		+
		+
		+	==Material Group Functions==

	==Simulation Setup and Meshing Functions==		==Simulation Setup and Meshing Functions==