ReferenceTargetList Class Reference

ReferenceTargetList class is used to manage the list of ReferenceTarget objects. It enables to create, duplicate, and delete a ReferenceTarget.
The class can be called from Model class.
. More...

Public Member Functions
ReferenceTarget *	CopyReferenceTarget (ReferenceTarget *cutplane)
	Creates information for specified ReferenceTargets. More...
ReferenceTarget *	CreateEdgeReferenceTarget (String &name=String("untitled"))
	Creates an edges ReferenceTarget. More...
ReferenceTarget *	CreateFaceReferenceTarget (String &name=String("untitled"))
	Creates a faces ReferenceTarget. More...
ReferenceTarget *	CreateVertexReferenceTarget (String &name=String("untitled"))
	Creates a vertices ReferenceTarget. More...
void	DeleteReferenceTarget (Variant &var)
	Deletes ReferenceTarget information. More...
void	DeleteUnusedReferenceTargets ()
	Deletes unused ReferenceTargets.
ReferenceTarget *	DuplicateReferenceTarget (Variant &var)
	Copies the ReferenceTarget by specifying a name or index. More...
ReferenceTarget *	GetReferenceTarget (Variant &var)
	Returns a ReferenceTarget object by specifying a name or index. More...
bool	IsValid ()
	Returns True if an object is valid. More...
int	NumReferenceTarget ()
	Returns the number of ReferenceTargets included in an assembly. More...

Detailed Description

ReferenceTargetList class is used to manage the list of ReferenceTarget objects. It enables to create, duplicate, and delete a ReferenceTarget.
The class can be called from Model class.
.

Example of calling the class object:

app.GetModel(0).GetReferenceTargetList()

Member Function Documentation

ReferenceTarget * ReferenceTargetList::CopyReferenceTarget

(

ReferenceTarget *

cutplane

)

Creates information for specified ReferenceTargets.

Parameters

cutplane

ReferenceTarget object

Returns

ReferenceTarget object

ReferenceTarget * ReferenceTargetList::CreateEdgeReferenceTarget

(

String &

name = String("untitled")

)

Creates an edges ReferenceTarget.

Parameters

name	ReferenceTarget name

Returns

ReferenceTarget object

ReferenceTarget * ReferenceTargetList::CreateFaceReferenceTarget

(

String &

name = String("untitled")

)

Creates a faces ReferenceTarget.

Parameters

name	ReferenceTarget name

Returns

ReferenceTarget object

ReferenceTarget * ReferenceTargetList::CreateVertexReferenceTarget

(

String &

name = String("untitled")

)

Creates a vertices ReferenceTarget.

Parameters

name	ReferenceTarget name

Returns

ReferenceTarget object

void ReferenceTargetList::DeleteReferenceTarget

(

Variant &

var

)

Deletes ReferenceTarget information.

Parameters

var	Name or index of the reference target

The oldest ReferenceTarget is deleted when specifying a ReferenceTarget to be deleted with a name and multiple ReferenceTargets with the same name exist.

ReferenceTarget * ReferenceTargetList::DuplicateReferenceTarget

(

Variant &

var

)

Copies the ReferenceTarget by specifying a name or index.

Parameters

var	Name or index of the reference target

Returns

ReferenceTarget object

ReferenceTarget * ReferenceTargetList::GetReferenceTarget

(

Variant &

var

)

Returns a ReferenceTarget object by specifying a name or index.

Parameters

var	Name or index of the reference target

Returns

ReferenceTarget object

bool ReferenceTargetList::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the ReferenceTargetList object in the list is valid

int ReferenceTargetList::NumReferenceTarget

(

)

Returns the number of ReferenceTargets included in an assembly.

Returns

Number of ReferenceTargets