Interface: manip

This represents the Core Interface to Manipulators.

Interface: manip

Properties:

.msXYPlane : Interface : Read

.msXZPlane : Interface : Read

.msYZPlane : Interface : Read

Return a manipPlane MixinInterface providing methods to get intersections with the respective plane.

Methods:

<mesh>makeSphere <point3>pos <float>radius <integer>segments

This returns a mesh sphere with the given position, radius, and segments.

<point3>pos: Sets the mesh sphere Position

<float>radius: Specifies the radius of the sphere.

<integer>segments: Sets the number of polygonal divisions for the sphere.

<mesh>makeTorus <point3>pos <float>radius <float>radius2 <integer>segs <integer>sides

Create a torus mesh with the given values.

<point3>pos: Sets the position of the torus.

<float>radius: Sets the distance from the center of the torus to the center of the cross-sectional circle. This is the radius of the torus ring.

<float>radius2: Sets the radius of the cross-sectional circle. The default is 10 units. This value is replaced each time you create a torus.

<integer>segs: Sets the number of radial divisions around the torus. By reducing this number, you can create polygonal rings instead of circular ones.

<integer>sides: Sets the number of sides on the cross-sectional circle of the torus. By reducing this number, you can create prism-like cross sections instead of circular ones.

<mesh>makeBox <point3>pos <float>l <float>w <float>h <integer>lsegs <integer>wsegs <integer>hsegs

Creates a box mesh with the given parameters.

<point3>pos: Sets the position of the Box.

<float>l: Sets the length, width, and height of the Box object. These fields also act as readouts while you drag the sides of the box. Default=0,0,0.

<float>w: Sets the length, width, and height of the Box object. These fields also act as readouts while you drag the sides of the box. Default=0,0,0.

<float>h: Sets the length, width, and height of the Box object. These fields also act as readouts while you drag the sides of the box. Default=0,0,0.

<integer>lsegs: Sets the number of divisions along each axis of the object. Can be set before or after creation. By default, each side of the box is a single segment. When you reset these values, the new values become the default during a session. Default=1,1,1.

Tip: Increase the Segments settings to give objects extra resolution for being affected by modifiers. For example, if you're going to bend a box on the Z axis, you might want to set its Height Segments parameter to 4 or more.

<integer>wsegs: Sets the number of divisions along each axis of the object. Can be set before or after creation. By default, each side of the box is a single segment. When you reset these values, the new values become the default during a session. Default=1,1,1.

Tip: Increase the Segments settings to give objects extra resolution for being affected by modifiers. For example, if you're going to bend a box on the Z axis, you might want to set its Height Segments parameter to 4 or more.

<integer>hsegs: Sets the number of divisions along each axis of the object. Can be set before or after creation. By default, each side of the box is a single segment. When you reset these values, the new values become the default during a session. Default=1,1,1.

Tip: Increase the Segments settings to give objects extra resolution for being affected by modifiers. For example, if you're going to bend a box on the Z axis, you might want to set its Height Segments parameter to 4 or more.

 

<Interface>makeCircle <point3>center <float>radius <integer>segments

Creates a circle with the given parameters.

<point3>center: Sets the position of the Circle.

<float>radius: Sets the radius of the Circle.

<integer>segments: Sets the number of segments in the Circle.

 

<Interface>makeGizmoShape()

Returns a gizmoShape Interface representing an empty gizmo shape that can be used to create user-defined gizmos by adding points to define freeform lines.

 

<Interface>makePlaneFromPts <point3>p1 <point3>p2 <point3>p3

Returns a manipPlane Interface representing a plane passing through the three given points.

<point3>p1 - first point of the plane definition

<point3>p2 - second point of the plane definition

<point3>p3 - third point of the plane definition

<Interface>makePlaneFromNormal <point3>normal <point3>point

Returns a manipPlane Interface representing a plane with the given normal that passes through the given point.

<point3>normal : the normal of the plane

<point3>point : the point the plane passes through

 

See also

Scripted Manipulators

Interface: simpleManip

Interface: gizmoShape

Interface: manipPlane