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

Inherits ItemObject.

Public Member Functions
virtual void	AddPropertyByReference (String &name, ReferenceObject *value)
	Adds ReferenceObject object to a specified variable. 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...

int	GetType ()
	Returns a value of a method for specifying a reference point. More...

String	GetTypeAsString ()
	Returns how to specify a reference point as a string. More...

ReferenceObject *	GetVertex ()
	Returns the point to reference. More...

double	GetX ()
	Returns the value of the reference point in the X coordinate. More...

double	GetXOffset ()
	Returns the offset value from the reference point in the X coordinate. More...

double	GetY ()
	Returns the value of the reference point in the Y coordinate. More...

double	GetYOffset ()
	Returns the offset value from the reference point in the Y coordinate. More...

double	GetZ ()
	Returns the value of the reference point in the Z coordinate. More...

double	GetZOffset ()
	Returns the offset value from the reference point in the Z coordinate. More...

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

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

void	Set2Lines (ReferenceObject line1, ReferenceObject line2)
	Specifies the two lines to reference when the reference point is determined by the two lines. More...

void	SetName (String &name)
	Specifies a name. More...

void	SetOffset (double x, double y, double z)
	Specifies the offset value from the reference point in each coordinate. More...

void	SetPlaneAndLine (ReferenceObject plane, ReferenceObject line)
	Specifies the plane and line to reference when the reference point is determined by a plane and line. More...

void	SetPoint (double x, double y, double z)
	Specifies the offset value from the reference point in each coordinate. More...

virtual 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	SetType (int t)
	Specifies a value as the method for specifying a reference point. More...

void	SetTypeByString (String &t)
	Determines how to specify a reference point by using a string. More...

void	SetVertex (ReferenceObject *vertex)
	Specifies the point to reference. More...

void	SetX (double value)
	Specifies the value of the reference point in the X coordinate. More...

void	SetXOffset (double value)
	Specifies the offset value from the reference point in the X coordinate. More...

void	SetY (double value)
	Specifies the value of the reference point in the Y coordinate. More...

void	SetYOffset (double value)
	Specifies the offset value from the reference point in the Y coordinate. More...

void	SetZ (double value)
	Specifies the value of the reference point in the Z coordinate. More...

void	SetZOffset (double value)
	Specifies the offset value from the reference point in the Z coordinate. More...

Detailed Description

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

The ReferencePoint class includes the commands for the following operation.

Commands related setting a reference point

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)

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

int ReferencePoint::GetType ( )

Returns a value of a method for specifying a reference point.

Returns: 0 : Specifies the coordinate.

1 : Specifies the offset from the existing point.

2 : Specifies from the plane and line

3 : Specifies two lines

String ReferencePoint::GetTypeAsString ( )

Returns how to specify a reference point as a string.

Returns: Point : Specifies the coordinate

VertexOffset : Specifies the offset from the existing point

PlaneLine : Specifies from the plane and line

2Lines : Specifies two lines

ReferenceObject * ReferencePoint::GetVertex ( )

Returns the point to reference.

Returns: ReferenceObject object

double ReferencePoint::GetX ( )

Returns the value of the reference point in the X coordinate.

Returns: Value in the X coordinate

double ReferencePoint::GetXOffset ( )

Returns the offset value from the reference point in the X coordinate.

Returns: Offset value in the X coordinate

double ReferencePoint::GetY ( )

Returns the value of the reference point in the Y coordinate.

Returns: Value in the Y coordinate

double ReferencePoint::GetYOffset ( )

Returns the offset value from the reference point in the Y coordinate.

Returns: Offset value in the Y coordinate

double ReferencePoint::GetZ ( )

Returns the value of the reference point in the Z coordinate.

Returns: Value in the Z coordinate

double ReferencePoint::GetZOffset ( )

Returns the offset value from the reference point in the Z coordinate.

Returns: Offset value in the Z coordinate

bool ItemObject::IsValid ( )

virtualinherited

Returns True if an object is valid.

Returns: Whether or not the object are valid

Reimplemented in Sketch, Part, SketchItem, and MeshPart.

int ItemObject::NumItems ( )

inherited

Returns the number of items.

Returns: Item count

void ReferencePoint::Set2Lines	(	ReferenceObject *	line1,
		ReferenceObject *	line2
	)

Specifies the two lines to reference when the reference point is determined by the two lines.

Parameters

line1	ReferenceObject object
line2	ReferenceObject object

void ItemObject::SetName ( String & name )

inherited

Specifies a name.

Parameters

name Item name

void ReferencePoint::SetOffset	(	double	x,
		double	y,
		double	z
	)

Specifies the offset value from the reference point in each coordinate.

Parameters

x	Offset value in the X coordinate
y	Offset value in the Y coordinate
z	Offset value in the Z coordinate

void ReferencePoint::SetPlaneAndLine	(	ReferenceObject *	plane,
		ReferenceObject *	line
	)

Specifies the plane and line to reference when the reference point is determined by a plane and line.

Parameters

plane	ReferenceObject object
line	ReferenceObject object

void ReferencePoint::SetPoint	(	double	x,
		double	y,
		double	z
	)

Specifies the offset value from the reference point in each coordinate.

Parameters

x	Value in the X coordinate
y	Value in the Y coordinate
z	Value in the Z coordinate

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

virtualinherited

Specifies a value of property.

Parameters

name	Property name
value	Value of properties

Reimplemented in SketchItem.

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 ReferencePoint::SetType ( int t )

Specifies a value as the method for specifying a reference point.

Parameters

t	0 : Specifies the coordinate 1 : Specifies the offset from the existing point 2 : Specifies from the plane and line 3 : Specifies two lines

void ReferencePoint::SetTypeByString ( String & t )

Determines how to specify a reference point by using a string.

Parameters

t	Point : Specifies the coordinate VertexOffset : Specifies the offset from the existing point PlaneLine : Specifies from the plane and line 2Lines : Specifies two lines

void ReferencePoint::SetVertex ( ReferenceObject * vertex )

Specifies the point to reference.

Parameters

vertex ReferenceObject object

void ReferencePoint::SetX ( double value )

Specifies the value of the reference point in the X coordinate.

Parameters

value Value in the X coordinate

void ReferencePoint::SetXOffset ( double value )

Specifies the offset value from the reference point in the X coordinate.

Parameters

value Offset value in the X coordinate

void ReferencePoint::SetY ( double value )

Specifies the value of the reference point in the Y coordinate.

Parameters

value Value in the Y coordinate

void ReferencePoint::SetYOffset ( double value )

Specifies the offset value from the reference point in the Y coordinate.

Parameters

value Offset value in the Y coordinate

void ReferencePoint::SetZ ( double value )

Specifies the value of the reference point in the Z coordinate.

Parameters

value Value in the Z coordinate

void ReferencePoint::SetZOffset ( double value )

Specifies the offset value from the reference point in the Z coordinate.

Parameters

value Offset value in the Z coordinate

Public Member Functions

Detailed Description

Member Function Documentation