Click or drag to resize

IObjects Methods

The IObjects type exposes the following members.

Methods
  NameDescription
Public methodAddArcOfCircleFromCenterRadiusAngles
Adds an arc of a circle with specified radius and center defined on the active plane of the active coordinate system. The arc is limited by two angles: startAngle and endAngle. The angle is defined in right-handed coordinate system. The radius must be greater than precision. The arc name is "ArcOfCircle".
Public methodAddArcOfCircleFromCenterStartEnd
Adds an arc of a circle with specified center and radius calculated as a distance from center to startPoint/endPoint. The circle is defined on the active plane of the active coordinate system. The resulting arc is limited by two points: startPoint and endPoint. The arc name is "ArcOfCircle".
Public methodAddArcOfCircleFromPointsOnArc
Adds an arc of a circle between two points startPoint and endPoint and through arcPoint located between the first two. The distance between any of the three points must be greater than precision. The arc name is "ArcOfCircle".
Public methodAddArcOfCircleFromStartEndAngle
Adds an arc of a circle from startPoint to endPoint with specified angle. The orientation of the arc depends on the sign of the angle. The distance between startPoint and endPoint must be greater than precision. The arc name is "ArcOfCircle".
Public methodAddArcOfCircleFromStartEndRadius
Adds an arc of a circle from startPoint to endPoint with specified radius. The orientation of the arc depends on the value of positiveAngle. If positiveAngle is true, the angle will be positive in right-handed coordinate system. The distance between startPoint and endPoint must be greater than precision. The arc name is "ArcOfCircle".
Public methodAddBox
Adds a box with faces parallel to coordinate system axes. The created faces have the following names: "BottomXY", "TopXY", "BottomXZ", "TopXZ", "BottomYZ", "TopYZ". For example, "BottomXY" is the face parallel to the XY plane and has smaller value of Z component than "TopXY" face. All dimensions can have negative values.
Public methodAddBSpline
Adds a B-spline that is passing through a list of points. If isPeriodic is set to true the curve will be closed and the junction will be the first point given. The distances between two consecutive points must be greater than precision. The B-spline edge name is "BSpline".
Public methodAddCircle
Add a circle that is parallel to the active plane of the active coordinates system. The circle face name is "Circle". Radius must have a positive value.
Public methodAddCone
Adds a cone with bases parallel to the active plane of the active coordinate system. Cylinder axis is perpendicular to that plane. The created faces have the following names: "BottomBase", "TopBase" and "Side". "BottomBase" is always the face that the starting point lies on, regardless of actual relative position to the TopBase face. Both radii must have positive values. Height can have either positive or negative.
Public methodAddCylinder
Adds a cylinder with bases parallel to the active plane of the active coordinate system. Cylinder axis is perpendicular to that plane. The created faces have the following names: "BottomBase", "TopBase" and "Side". "BottomBase" is always the face that the starting point lies on, regardless of actual relative position to the TopBase face. Radius must have a positive value. Height can have either positive or negative.
Public methodAddEllipse
Add an ellipse that is parallel to the active plane of the active coordinates system. The dimensions that radius1 and radius2 are defined in depend on the active plane i.e. radius1 is always defined in the first dimension and radius2 in the second. For example, if the active plane is YZ plane, then radius1 is defined in Y dimension and radius2 is defined in Z dimension. The ellipse face name is "Ellipse". radius1 and radius2 must have positive values.
Public methodAddHelix
Adds a helix centered at p0. The helix axis is perpendicular to the active plane of the active coordinates system. The helix face name is "Helix". Both radii must have non-negative values.
Public methodAddHelix1D
Adds a helix centered at p0. The helix axis is perpendicular to the active plane of the active coordinates system. The helix face name is "Helix". Both radii must have non-negative values.
Public methodAddLine
Adds a line segment from startPoint to endPoint. The distance between two points must be greater than precision. The line segment edge name is "Line".
Public methodAddPolygon
Adds a polygon that is parallel to the active plane of the active coordinates system. Polygons are defined by their p0 and a list of points. The starting point and all vertexes must lie on a plane. The polygon face name is "Polygon".
Public methodAddPolyLine
Adds a polyline, a series of line segments, defined by a list of points. The lengths of all segments mu be greater than precision. Each segment of the polyline has its own name "PolyLine_PartN" where N is an index of the line segment starting from 0.
Public methodAddRectangle
Add a rectangle that is parallel to the active plane of the active coordinates system. The dimensions that width and height are defined in depend on the active plane i.e. width is always defined in the first dimension and height in the second. For example, if the active plane is YZ plane, then width is defined in Y dimension and height is defined in Z dimension. The rectangle face name is "Rectangle". width and height can have either positive or negative values.
Public methodAddRegularPolygon
Adds a regular polygon that is parallel to the active plane of the active coordinates system. A regular polygon is defined by its center, a vertex vertex and a numberOfSides. The polygon face name is "RegularPolygon".
Public methodAddSphere
Adds a sphere centered at p0. The sphere face name is "Sphere". Radius must have a positive value.
Public methodAddTorus
Adds a torus centered at p0. The torus plane is parallel to the active plane of the active coordinates system. The torus face name is "Torus". Both radii must have positive values.
Public methodCode exampleCloneAlongLine
Clones an object along line i.e. creates a series of clones placed along line with a specified offset.
Public methodCode exampleCloneAroundAxis
Clones an object around an axis i.e. creates a series of clones placed around an axis defined by the active coordinate system and spaced by a specified angle.
Public methodExtrudeAlongPath
Extrudes given profile (face) along a specified path (edge(s)).
Public methodExtrudeFaceAlongVector
Extrudes a face along a specified vector thus making a prism (solid).
Public methodExtrudeRuled
Creates a solid from two faces by creating ruled surfaces connecting each edge of the first face with the corresponding edge of the second face. The faces must have the same number of edges which will be connected by pairs starting from the pair edge1-edge2.
Public methodGet
Returns reference to an object with a specified name. If no object is found, ArgumentException is thrown.
Public methodGetByIndex
Returns reference to an object with the given index. If no object is found, ArgumentException is thrown.
Public methodIntersect
Performs logical intersection of two objects. Both object must be the same Type.
Public methodMakeChamfer
Creates chamfers of specified edges. In order to define chamfers list of edges must be specified based on which chamfers will be created. Chamfers are parameterized by two distances from the edge to two newly created edges. First distance is measured on a specified face and the second distance is measured on the other face.
Public methodMakeChamfer2
Creates chamfers of specified edges. In order to define chamfers list of edges must be specified based on which chamfers will be created. Chamfers are parameterized by two distances from the edge to two newly created edges. First distance is measured on a specified face and the second distance is measured on the other face.
Public methodMakeFace
Creates a face having the boundary specified by the profile.
Public methodMakeFillet
Creates fillets of specified edges and of specified radius.
Public methodMakeFillet2
Creates fillets of specified edges and of specified radius.
Public methodMakeRevolutionObject
Creates an object of revolution by rotating a face around active coordinate system axis.
Public methodCode exampleMove
Moves an object by a specified offset in the active coordinate system.
Public methodCode exampleReflect
Reflects object by a specified plane of the active coordinate system.
Public methodRemove
Removes object from the project.
Public methodRemoveAll
Removes all objects from the project.
Public methodCode exampleRotate
Rotates an object by a specified angle around the center of active coordinate system. The axis of rotation is the axis of the coordinate system perpendicular to the active plane.
Public methodSubstract
Performs logical substraction of two objects. Both object must be the same Type.
Public methodUnite
Performs logical union of two objects. Both object must be the same Type.
Top
See Also