Public Member Functions | List of all members
SketchArc Class Reference

SketchArc Class
The commands in the SketchArc 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 arc. More...
 
SketchVertexGetEndVertex ()
 Returns the end point of the 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...
 
String GetName ()
 Returns a name. More...
 
virtual Variant GetProperty (String &name)
 Returns the value of the property with the specified name. More...
 
double GetRadius ()
 Returns the radius of the arc. More...
 
String GetScriptTypeName ()
 Returns the name of the object type as a string. More...
 
SketchVertexGetStartVertex ()
 Returns the start point of the 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 arc in the coordinate. More...
 
void SetCenterVertex (SketchVertex *v)
 Specifies the center point of the arc to be the same position as the existing point. More...
 
void SetData (double center_x, double center_y, double radius)
 Specifies the center point of the arc in the coordinate and the radius of the arc. More...
 
void SetEnd (double end_x, double end_y)
 Specifies the end point of the arc in the coordinate. More...
 
void SetEndVertex (SketchVertex *v)
 Specifies the end point of the arc to be the same position as the existing point. 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 SetRadius (double r)
 Specifies the radius of the arc. More...
 
void SetStart (double start_x, double start_y)
 Specifies the start point of the arc in the coordinate. More...
 
void SetStartVertex (SketchVertex *v)
 Specifies the start point of the arc to be the same position as the existing point. More...
 

Detailed Description

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

The SketchArc class includes the commands for the following operation.

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 * SketchArc::GetCenterVertex ( )

Returns the center point of the arc.

Returns
SketchVertex object
SketchVertex * SketchArc::GetEndVertex ( )

Returns the end point of the 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
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
double SketchArc::GetRadius ( )

Returns the radius of the arc.

Returns
Radius of the arc
String ItemObject::GetScriptTypeName ( )
inherited

Returns the name of the object type as a string.

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

Returns the start point of the 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 SketchArc::SetCenter ( double  center_x,
double  center_y 
)

Specifies the center point of the arc in the coordinate.

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

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

Parameters
vSketchVertex object
void SketchArc::SetData ( double  center_x,
double  center_y,
double  radius 
)

Specifies the center point of the arc in the coordinate and the radius of the arc.

Parameters
center_xCenter point in the X coordinate
center_yCenter point in the Y coordinate
radius
Deprecated:
Please use SetProperty().
void SketchArc::SetEnd ( double  end_x,
double  end_y 
)

Specifies the end point of the arc in the coordinate.

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

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

Parameters
vSketchVertex object
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 SketchArc::SetRadius ( double  r)

Specifies the radius of the arc.

Parameters
rRadius of the arc
void SketchArc::SetStart ( double  start_x,
double  start_y 
)

Specifies the start point of the arc in the coordinate.

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

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

Parameters
vSketchVertex object