Public Member Functions | List of all members
SketchEllipse Class Reference

SketchEllipse Class
The commands in the SketchEllipse 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 ellipse. 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 ellipse. More...
 
double GetMajorRadius ()
 Returns the major radius of the ellipse. More...
 
double GetMinorRadius ()
 Returns the minor radius of the ellipse. 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...
 
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 ellipse in the coordinate. More...
 
void SetCenterVertex (SketchVertex *v)
 Specifies the center point of the ellipse 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 ellipse in the coordinate, the radius and the rotation angle of the ellipse. More...
 
void SetMajorAngle (double angle)
 Specifies the rotation angle of the ellipse. More...
 
void SetMajorRadius (double r)
 Specifies the major radius of the ellipse. More...
 
void SetMinorRadius (double r)
 Specifies the minor radius of the ellipse. 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...
 

Detailed Description

SketchEllipse Class
The commands in the SketchEllipse 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 * SketchEllipse::GetCenterVertex ( )

Returns the center point of the ellipse.

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 SketchEllipse::GetMajorAngle ( )

Returns the rotation angle of the ellipse.

Returns
Rotation angle
double SketchEllipse::GetMajorRadius ( )

Returns the major radius of the ellipse.

Returns
Major radius of the ellipse
double SketchEllipse::GetMinorRadius ( )

Returns the minor radius of the ellipse.

Returns
Minor radius of the ellipse
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
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 SketchEllipse::SetCenter ( double  center_x,
double  center_y 
)

Specifies the center point of the ellipse in the coordinate.

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

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

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

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

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 ellipse
Deprecated:
Please use SetProperty().
void SketchEllipse::SetMajorAngle ( double  angle)

Specifies the rotation angle of the ellipse.

Parameters
angleRotation angle of the ellipse
void SketchEllipse::SetMajorRadius ( double  r)

Specifies the major radius of the ellipse.

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

Specifies the minor radius of the ellipse.

Parameters
rMinor radius of the ellipse
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)