SketchLine Class
The commands in the SketchLine 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 *	GetEndVertex ()
	Returns the end point of the line. 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...

String	GetScriptTypeName ()
	Returns the name of the object type as a string. More...

SketchVertex *	GetStartVertex ()
	Returns the start point of the line. More...

virtual bool	IsValid ()
	Returns True if an object is valid. More...

int	NumItems ()
	Returns the number of items. More...

void	SetData (double start_x, double start_y, double end_x, double end_y)
	Specifies the start point and end point of the line in the coordinate. More...

void	SetEnd (double end_x, double end_y)
	Specifies the end point of the line in the coordinate. More...

void	SetEndVertex (SketchVertex *v)
	Specifies the end point of the line 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	SetStart (double start_x, double start_y)
	Specifies the start point of the line in the coordinate. More...

void	SetStartVertex (SketchVertex *v)
	Specifies the start point of the line to be the same position as the existing point. More...

Detailed Description

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

The SketchLine class includes the commands for the following operation.

Commands related to setting a line

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 * SketchLine::GetEndVertex ( )

Returns the end point of the line.

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

String ItemObject::GetScriptTypeName ( )

inherited

Returns the name of the object type as a string.

Returns: Type name of object

SketchVertex * SketchLine::GetStartVertex ( )

Returns the start point of the line.

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 SketchLine::SetData	(	double	start_x,
		double	start_y,
		double	end_x,
		double	end_y
	)

Specifies the start point and end point of the line in the coordinate.

Parameters

start_x	Start point in the X coordinate
start_y	Start point in the Y coordinate
end_x	End point in the X coordinate
end_y	End point in the Y coordinate

Deprecated:: Please use SetProperty().

void SketchLine::SetEnd	(	double	end_x,
		double	end_y
	)

Specifies the end point of the line in the coordinate.

Parameters

end_x	End point in the X coordinate
end_y	End point in the Y coordinate

void SketchLine::SetEndVertex ( SketchVertex * v )

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

Parameters

v	SketchVertex object

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 SketchLine::SetStart	(	double	start_x,
		double	start_y
	)

Specifies the start point of the line in the coordinate.

Parameters

start_x	Start point in the X coordinate
start_y	Start point in the Y coordinate

void SketchLine::SetStartVertex ( SketchVertex * v )

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

Parameters

v	SketchVertex object

Public Member Functions

Detailed Description

Member Function Documentation