SketchCircle Class
The commands in the SketchCircle 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...

SketchVertex *	GetCenterVertex ()
	Returns the center point of the circle. More...

ItemObject *	GetItem (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 circle. 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 x, double y)
	Specifies the center point of the circle in the coordinate. More...

void	SetCenterVertex (SketchVertex *v)
	Specifies the center point of the circle to be the same position as the existing point. More...

void	SetData (double x, double y, double radius)
	Specifies the center point of the circle in the coordinate and the radius of the circle. 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 circle. More...

Detailed Description

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

The SketchCircle class includes the commands for the following operation.

Commands related to setting a circle

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

name	Property name
value	ReferenceObject object (target)

SketchVertex * SketchCircle::GetCenterVertex ( )

Returns the center point of the circle.

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

value Item 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

name	Property name

Returns: Value of properties

double SketchCircle::GetRadius ( )

Returns the radius of the circle.

Returns: Radius of the circle

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 SketchCircle::SetCenter	(	double	x,
		double	y
	)

Specifies the center point of the circle in the coordinate.

Parameters

x	Center point in the X coordinate
y	Center point in the Y coordinate

void SketchCircle::SetCenterVertex ( SketchVertex * v )

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

Parameters

v	SketchVertex object

void SketchCircle::SetData	(	double	x,
		double	y,
		double	radius
	)

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

Parameters

center_x	Center point in the X coordinate
center_y	Center point in the Y coordinate
radius

Deprecated:: Please use SetProperty().

void ItemObject::SetName ( String & name )

inherited

Specifies a name.

Parameters

name Item name

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

virtualinherited

Specifies a value of property.

Parameters

name	Property name
value	Value of properties

Reimplemented from ItemObject.

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

virtualinherited

Specifies the values in properties by ReferenceObject object.

Parameters

name	Property name
value	ReferenceObject object (target)

void SketchCircle::SetRadius ( double r )

Specifies the radius of the circle.

Parameters

r	Radius of the circle

Public Member Functions

Detailed Description

Member Function Documentation