Public Member Functions | List of all members
CutList Class Reference

CutList class is used to control the list of CutPlane objects. It enables to create, duplicate, and delete a cut plane.
The class can be called from Model class.
. More...

Public Member Functions

CutPlaneCopyCut (CutPlane *cutplane)
 Copies a CutPlane object. More...
 
CutPlaneCopyCutPlane (CutPlane *cutplane)
 Copies a CutPlane object. More...
 
CutPlaneCreateCutCylinder (String &name=String("untitled"))
 Creates a cut cylinder. More...
 
CutPlaneCreateCutPlane (String &name=String("untitled"))
 Creates a cut plane. More...
 
void DeleteCut (Variant &var)
 Deletes a CutPlane object by specifying the name or index. More...
 
void DeleteCutPlane (Variant &var)
 Deletes a CutPlane object by specifying the name or index. More...
 
CutPlaneDuplicateCut (Variant &var)
 Duplicates a CutPlane object by specifying the name or index. More...
 
CutPlaneGetCut (Variant &var)
 Returns a cut plane by specifying the name or index. More...
 
CutPlaneGetCutPlane (Variant &var)
 Returns a CutPlane object by specifying the name or index. More...
 
bool IsShowOnlyCutFaces ()
 Returns whether or not cut planes are displayed. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 
int NumCut ()
 Returns the number of cut planes as an integer. More...
 
int NumCutPlanes ()
 Returns the number of cut planes as an integer. More...
 
void ShowOnlyCutFaces (bool show)
 Displays the cut planes only. More...
 

Detailed Description

CutList class is used to control the list of CutPlane objects. It enables to create, duplicate, and delete a cut plane.
The class can be called from Model class.
.

Example of calling the class object:

app.GetModel(0).GetCutList()

Member Function Documentation

CutPlane * CutList::CopyCut ( CutPlane cutplane)

Copies a CutPlane object.

Parameters
cutplaneCutPlane object
Returns
CutPlane object
CutPlane * CutList::CopyCutPlane ( CutPlane cutplane)

Copies a CutPlane object.

Parameters
cutplaneCutPlane object
Returns
CutPlane object
CutPlane * CutList::CreateCutCylinder ( String &  name = String("untitled"))

Creates a cut cylinder.

Parameters
nameCut plane name
Returns
CutPlane object
CutPlane * CutList::CreateCutPlane ( String &  name = String("untitled"))

Creates a cut plane.

Parameters
nameCut plane name
Returns
CutPlane object
void CutList::DeleteCut ( Variant &  var)

Deletes a CutPlane object by specifying the name or index.

Parameters
varName or index of the cut plane
Returns
CutPlane object
void CutList::DeleteCutPlane ( Variant &  var)

Deletes a CutPlane object by specifying the name or index.

Parameters
varName or index of the cut plane
Returns
CutPlane object
CutPlane * CutList::DuplicateCut ( Variant &  var)

Duplicates a CutPlane object by specifying the name or index.

Parameters
varName or index of the cut plane
Returns
CutPlane object
CutPlane * CutList::GetCut ( Variant &  var)

Returns a cut plane by specifying the name or index.

Parameters
varName or index of the cut plane
CutPlane * CutList::GetCutPlane ( Variant &  var)

Returns a CutPlane object by specifying the name or index.

Parameters
varName or index of the cut plane
bool CutList::IsShowOnlyCutFaces ( )

Returns whether or not cut planes are displayed.

Returns
1 or 0
1: Cut planes are displayed
0: Cut planes are not displayed
bool CutList::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the CutList object in the list is valid
int CutList::NumCut ( )

Returns the number of cut planes as an integer.

Returns
Number of cut planes
int CutList::NumCutPlanes ( )

Returns the number of cut planes as an integer.

Returns
Number of cut planes
void CutList::ShowOnlyCutFaces ( bool  show)

Displays the cut planes only.

Parameters
show
Integer : 1 or 0
1: Cut planes are displayed
0: Cut planes are not displayed