Public Member Functions | List of all members
SketchEllipticalArc Class Reference

SketchEllipticalArc Class
The commands in the SketchEllipticalArc class are described below.
. More...

Inherits SketchItem.

Public Member Functions

virtual void AddPropertyByReference (String &name, ReferenceObject *value)
 Adds ReferenceObject object to a specified variable. More...
 
SketchVertexGetCenterVertex ()
 Returns the center point of the elliptical arc. More...
 
SketchVertexGetEndVertex ()
 Returns the end point of the elliptical arc. More...
 
ItemObjectGetItem (Variant &value)
 Returns an item displayed in the [Model Manager] tree such as assembly, part and sketch. Index is numbered in the order of the each items shown in the tree. More...
 
double GetMajorAngle ()
 Returns the rotation angle of the elliptical arc. More...
 
double GetMajorRadius ()
 Returns the major radius of the elliptical arc. More...
 
double GetMinorRadius ()
 Returns the minor radius of the elliptical arc. More...
 
String GetName ()
 Returns a name. More...
 
virtual Variant GetProperty (String &name)
 Returns the value of the property with the specified name. More...
 
String GetScriptTypeName ()
 Returns the name of the object type as a string. More...
 
SketchVertexGetStartVertex ()
 Returns the start point of the elliptical arc. More...
 
virtual bool IsValid ()
 Returns True if an object is valid. More...
 
int NumItems ()
 Returns the number of items. More...
 
void SetCenter (double center_x, double center_y)
 Specifies the center point of the lliptical arc in the coordinate. More...
 
void SetCenterVertex (SketchVertex *v)
 Specifies the center point of the elliptical arc to be the same position as the existing point. More...
 
void SetData (double center_x, double center_y, double major_radius, double minor_radius, double major_angle)
 Specifies the center point of the elliptical arc in the coordinate, the radius and the rotation angle of the elliptical arc. More...
 
void SetEnd (double end_x, double end_y)
 Specifies the end point of the lliptical arc in the coordinate. More...
 
void SetEndVertex (SketchVertex *v)
 Specifies the end point of the elliptical arc to be the same position as the existing point. More...
 
void SetMajorAngle (double angle)
 Specifies the rotation angle of the elliptical arc. More...
 
void SetMajorRadius (double r)
 Specifies the major radius of the elliptical arc. More...
 
void SetMinorRadius (double r)
 Specifies the minor radius the elliptical arc. More...
 
void SetName (String &name)
 Specifies a name. More...
 
void SetProperty (String &name, Variant &value)
 Specifies a value of property. More...
 
virtual void SetPropertyByReference (String &name, ReferenceObject *value)
 Specifies the values in properties by ReferenceObject object. More...
 
void SetStart (double start_x, double start_y)
 Specifies the start point of the lliptical arc in the coordinate. More...
 
void SetStartVertex (SketchVertex *v)
 Specifies the start point of the elliptical arc to be the same position as the existing point. More...
 

Detailed Description

SketchEllipticalArc Class
The commands in the SketchEllipticalArc class are described below.
.

For more information about the properties for this class, see here .

Member Function Documentation

void ItemObject::AddPropertyByReference ( String &  name,
ReferenceObject value 
)
virtualinherited

Adds ReferenceObject object to a specified variable.

Parameters
nameProperty name
valueReferenceObject object (target)
SketchVertex * SketchEllipticalArc::GetCenterVertex ( )

Returns the center point of the elliptical arc.

Returns
SketchVertex object
SketchVertex * SketchEllipticalArc::GetEndVertex ( )

Returns the end point of the elliptical arc.

Returns
SketchVertex object
ItemObject * ItemObject::GetItem ( Variant &  value)
inherited

Returns an item displayed in the [Model Manager] tree such as assembly, part and sketch. Index is numbered in the order of the each items shown in the tree.

Parameters
valueItem name or index
Returns
ItemObject object
double SketchEllipticalArc::GetMajorAngle ( )

Returns the rotation angle of the elliptical arc.

Returns
Rotation angle of the elliptical arc
double SketchEllipticalArc::GetMajorRadius ( )

Returns the major radius of the elliptical arc.

Returns
Major radius of the elliptical arc
double SketchEllipticalArc::GetMinorRadius ( )

Returns the minor radius of the elliptical arc.

Returns
Minor radius of the elliptical arc
String ItemObject::GetName ( )
inherited

Returns a name.

Returns
Item name
Variant ItemObject::GetProperty ( String &  name)
virtualinherited

Returns the value of the property with the specified name.

Parameters
nameProperty name
Returns
Value of properties
String ItemObject::GetScriptTypeName ( )
inherited

Returns the name of the object type as a string.

Returns
Type name of object
SketchVertex * SketchEllipticalArc::GetStartVertex ( )

Returns the start point of the elliptical arc.

Returns
SketchVertex object
virtual bool SketchItem::IsValid ( )
virtualinherited

Returns True if an object is valid.

Returns
Whether or not the object are valid

Reimplemented from ItemObject.

int ItemObject::NumItems ( )
inherited

Returns the number of items.

Returns
Item count
void SketchEllipticalArc::SetCenter ( double  center_x,
double  center_y 
)

Specifies the center point of the lliptical arc in the coordinate.

Parameters
center_xCenter point in the X coordinate
center_yCenter point in the Y coordinate
void SketchEllipticalArc::SetCenterVertex ( SketchVertex v)

Specifies the center point of the elliptical arc to be the same position as the existing point.

Parameters
vSketchVertex object
void SketchEllipticalArc::SetData ( double  center_x,
double  center_y,
double  major_radius,
double  minor_radius,
double  major_angle 
)

Specifies the center point of the elliptical arc in the coordinate, the radius and the rotation angle of the elliptical arc.

Parameters
center_xCenter point in the X coordinate
center_yCenter point in the Y coordinate
major_radiusRadius of the major axis
minor_radiusRadius of the minor axis
major_angleRotation angle of elliptical arc
Deprecated:
Please use SetProperty().
void SketchEllipticalArc::SetEnd ( double  end_x,
double  end_y 
)

Specifies the end point of the lliptical arc in the coordinate.

Parameters
end_xEnd point in the X coordinate
end_yEnd point in the Y coordinate
void SketchEllipticalArc::SetEndVertex ( SketchVertex v)

Specifies the end point of the elliptical arc to be the same position as the existing point.

Parameters
vSketchVertex object
void SketchEllipticalArc::SetMajorAngle ( double  angle)

Specifies the rotation angle of the elliptical arc.

Parameters
angleRotation angle of the elliptical arc
void SketchEllipticalArc::SetMajorRadius ( double  r)

Specifies the major radius of the elliptical arc.

Parameters
rMajor radius of the ellipse
void SketchEllipticalArc::SetMinorRadius ( double  r)

Specifies the minor radius the elliptical arc.

Parameters
rMinor radius of the elliptical arc
void ItemObject::SetName ( String &  name)
inherited

Specifies a name.

Parameters
nameItem name
void SketchItem::SetProperty ( String &  name,
Variant &  value 
)
virtualinherited

Specifies a value of property.

Parameters
nameProperty name
valueValue of properties

Reimplemented from ItemObject.

void ItemObject::SetPropertyByReference ( String &  name,
ReferenceObject value 
)
virtualinherited

Specifies the values in properties by ReferenceObject object.

Parameters
nameProperty name
valueReferenceObject object (target)
void SketchEllipticalArc::SetStart ( double  start_x,
double  start_y 
)

Specifies the start point of the lliptical arc in the coordinate.

Parameters
start_xStart point in the X coordinate
start_yStart point in the Y coordinate
void SketchEllipticalArc::SetStartVertex ( SketchVertex v)

Specifies the start point of the elliptical arc to be the same position as the existing point.

Parameters
vSketchVertex object