ReferenceTarget Class Reference

ReferenceTarget class is used for ReferenceTarget settings.
The class can be called from ReferenceTargetList or CalculationDefinition class
. More...

Public Member Functions
void	AddSelected (Selection *selection)
	Adds the selected faces, edges, or vertices to the ReferenceTarget. More...
void	ClearParts ()
	Removes all faces, edges, or vertices from the ReferenceTarget.
Variant	GetID ()
	Returns information of edge, face, or vertex included in a ReferenceTarget. More...
String	GetName ()
	Returns ReferenceTarget name. More...
Selection *	GetSelection ()
	Returns the Selection object of the edge, face, or vertex included in a ReferenceTarget. More...
String	GetType ()
	Returns ReferenceTarget type. More...
bool	IsParallelDirection ()
	Returns the relation of edge. More...
bool	IsReversed ()
	Returns the status of the reverse flag for the reference target. More...
bool	IsValid ()
	Returns True if an object is valid. More...
int	NumParts ()
	Returns the number of faces, edges, or vertices. More...
void	SetName (String &name)
	Specifies a ReferenceTarget name. More...
void	SetParallelDirection (bool parallel)
void	SetReversed (bool reversed)
	Specifies the reverse flag for the reference target True or False. More...
void	SetType (String &type)
	Specifies a ReferenceTarget type. More...

Detailed Description

ReferenceTarget class is used for ReferenceTarget settings.
The class can be called from ReferenceTargetList or CalculationDefinition class
.

Example of calling the class object:

app.GetModel(0).GetReferenceTargetList().GetReferenceTarget(0)

Member Function Documentation

void ReferenceTarget::AddSelected

(

Selection *

selection

)

Adds the selected faces, edges, or vertices to the ReferenceTarget.

Parameters

selection

Selected faces, edges, or vertices

Variant ReferenceTarget::GetID

(

)

Returns information of edge, face, or vertex included in a ReferenceTarget.

Returns

IDs of the edge, face, or vertex included in a ReferenceTarget

String ReferenceTarget::GetName

(

)

Returns ReferenceTarget name.

Returns

ReferenceTarget name

Selection * ReferenceTarget::GetSelection

(

)

Returns the Selection object of the edge, face, or vertex included in a ReferenceTarget.

Returns

Selection object

String ReferenceTarget::GetType

(

)

Returns ReferenceTarget type.

Returns

ReferenceTarget type (Face, Edge, or Vertex)

bool ReferenceTarget::IsParallelDirection

(

)

Returns the relation of edge.

Returns

True=1 : Parallel
False=0 : Perpendicular

bool ReferenceTarget::IsReversed

(

)

Returns the status of the reverse flag for the reference target.

Returns

True=1 : Reversed
False=0 : Not Reversed

bool ReferenceTarget::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the ReferenceTarget object is valid

int ReferenceTarget::NumParts

(

)

Returns the number of faces, edges, or vertices.

Returns

Number of edges, faces, or vertices

void ReferenceTarget::SetName

(

String &

name

)

Specifies a ReferenceTarget name.

Parameters

name	ReferenceTarget names of face, edge, and vertex

void ReferenceTarget::SetParallelDirection

(

bool

parallel

)

Specifies the relation of edge with True or False.

Parameters

parallel

True=1 : Parallel False=0 : Perpendicular

void ReferenceTarget::SetReversed

(

bool

reversed

)

Specifies the reverse flag for the reference target True or False.

Parameters

reverse

True=1 : Reversed False=0 : Not Reversed

void ReferenceTarget::SetType

(

String &

type

)

Specifies a ReferenceTarget type.

Parameters

type	ReferenceTarget type (Face, Edge, or Vertex)