CutPlane class is used to handle settings and the display of a cut plane.
The class can be called from CutList class.
. More...

Public Member Functions
String	GetDisplayType ()
	Returns the display type of the cut plane or cut cylinder. More...

String	GetName ()
	Returns the name of the cut plane as a string. More...

Point *	GetNormal ()
	Returns the normal vector of the cut plane as a Point object. More...

Point *	GetOrigin ()
	Returns the origin point of the cut plane as a Point object. More...

Point *	GetOriginWithUnit (String &unitName)
	Returns the origin point of the cut plane in the specified unit. More...

double	GetRadius ()
	Returns the radius of the cut cylinder. More...

double	GetRadiusWithUnit (String &unitName)
	Returns the radius of the cut cylinder in the specified unit. More...

bool	GetShowCutOnly ()

bool	IsOn ()
	Returns the state of the cut plane, and Returns True as a return value if the switch is turned on. More...

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

int	NumCircumferentialDivisions ()
	Returns the number of divisions in the circumferential direction of the cut cylinder. More...

void	Off ()
	Turns off the switch of the cut plane.

void	On ()
	Turns on the switch of the cut plane.

void	SetDisplayType (String &typeName)
	Specifies the display type of the cut plane or cut cylinder. More...

void	SetName (String &name)
	Specifies the name of the cut plane. More...

void	SetNormal (Point *normal)
	Specifies the normal vector of the cut plane. More...

void	SetNormalXYZ (double x, double y, double z)
	Specifies the normal vector of the cut plane by using x, y, and z. More...

void	SetNumCircumferentialDivisions (int num)
	Specifies the number of divisions in the circumferential direction of the cut cylinder. More...

void	SetOrigin (Point *origin)
	Specifies a point on the cut plane. More...

void	SetOriginWithUnit (Point *origin, String &unitName)
	Specifies a point on the cut plane by specifying the unit. More...

void	SetOriginXYZ (double x, double y, double z)
	Specifies a point on the cut plane as x,y,z coordinates. More...

void	SetOriginXYZWithUnit (double x, double y, double z, String &unitName)
	Specifies a point on the cut plane as x,y,z coordinates. More...

void	SetRadius (double radius)
	Specifies the radius of the cut cylinder. More...

void	SetRadiusWithUnit (double radius, String &unitName)
	Specifies the radius of the cut cylinder. More...

void	SetShowCutOnly (bool flag)

void	SetUseCircumferentialDivisions (bool use)
	Specifies whether to use the number of circumferential divisions of the cut cylinder. More...

bool	UseCircumferentialDivisions ()
	Returns whether to use the number of circumferential divisions of the cut cylinder. More...

Detailed Description

CutPlane class is used to handle settings and the display of a cut plane.
The class can be called from CutList class.
.

Example of obtaining the class object:

app.GetModel(0).GetCutList().GetCut(0)

Member Function Documentation

String CutPlane::GetDisplayType ( )

Returns the display type of the cut plane or cut cylinder.

Returns

Display type

Cut plane:
1 : ShowAbove : Displays the model from the front of the plane
2 : ShowBehind : Displays the model from the behind of the plane
3 : ShowBoth : Displays the model from the front/behind of the plane
Cut cylinder:
4 : ShowInside : Displays the model from the inside of the cylinder
5 : ShowOutside : Displays the model from the outside of the cylinder
6 : ShowBoth : Displays the model from the inside/outside of the cylinder

String CutPlane::GetName ( )

Returns the name of the cut plane as a string.

Returns: Name of the cut plane

Point * CutPlane::GetNormal ( )

Returns the normal vector of the cut plane as a Point object.

Returns: Point object

Point * CutPlane::GetOrigin ( )

Returns the origin point of the cut plane as a Point object.

Returns: Point object

Point * CutPlane::GetOriginWithUnit ( String & unitName )

Returns the origin point of the cut plane in the specified unit.

Parameters

unitName Unit

Returns: Point object

double CutPlane::GetRadius ( )

Returns the radius of the cut cylinder.

Returns: Radius

double CutPlane::GetRadiusWithUnit ( String & unitName )

Returns the radius of the cut cylinder in the specified unit.

Parameters

unitName Unit

Returns: Radius

bool CutPlane::GetShowCutOnly ( )

Deprecated:

Returns the flag for displaying the cut part of the model.

Returns: Whether or not to display the cut part
True=1

False=0

bool CutPlane::IsOn ( )

Returns the state of the cut plane, and Returns True as a return value if the switch is turned on.

Returns: Switch ON/OFF of the cut plane
True=1

False=0

bool CutPlane::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the CutPlane object is valid

int CutPlane::NumCircumferentialDivisions ( )

Returns the number of divisions in the circumferential direction of the cut cylinder.

Returns: Number of divisions

void CutPlane::SetDisplayType ( String & typeName )

Specifies the display type of the cut plane or cut cylinder.

Parameters

typeName

Cut plane:
1 : ShowAbove : Displays the model from the front of the plane
2 : ShowBehind : Displays the model from the behind of the plane
3 : ShowBoth : Displays the model from the front/behind of the plane
Cut cylinder:
4 : ShowInside : Displays the model from the inside of the cylinder
5 : ShowOutside : Displays the model from the outside of the cylinder
6 : ShowBoth : Displays the model from the inside/outside of the cylinder

void CutPlane::SetName ( String & name )

Specifies the name of the cut plane.

Parameters

name	Name of the cut plane

void CutPlane::SetNormal ( Point * normal )

Specifies the normal vector of the cut plane.

Parameters

normal Point object (direction vector)

void CutPlane::SetNormalXYZ	(	double	x,
		double	y,
		double	z
	)

Specifies the normal vector of the cut plane by using x, y, and z.

Parameters

x	X-coordinate
y	Y-coordinate
z	Z-coordinate

void CutPlane::SetNumCircumferentialDivisions ( int num )

Specifies the number of divisions in the circumferential direction of the cut cylinder.

Parameters

num	Number of divisions

void CutPlane::SetOrigin ( Point * origin )

Specifies a point on the cut plane.

Parameters

origin Point object (start point)

void CutPlane::SetOriginWithUnit	(	Point *	origin,
		String &	unitName
	)

Specifies a point on the cut plane by specifying the unit.

Parameters

origin	Point object (start point)
unitName	Unit

void CutPlane::SetOriginXYZ	(	double	x,
		double	y,
		double	z
	)

Specifies a point on the cut plane as x,y,z coordinates.

Parameters

x	X-coordinate
y	Y-coordinate
z	Z-coordinate

void CutPlane::SetOriginXYZWithUnit	(	double	x,
		double	y,
		double	z,
		String &	unitName
	)

Specifies a point on the cut plane as x,y,z coordinates.

Parameters

x	X-coordinate
y	Y-coordinate
z	Z-coordinate
unitName	Unit

void CutPlane::SetRadius ( double radius )

Specifies the radius of the cut cylinder.

Parameters

radius Radius

void CutPlane::SetRadiusWithUnit	(	double	radius,
		String &	unitName
	)

Specifies the radius of the cut cylinder.

Parameters

radius	Radius
unitName	Unit

void CutPlane::SetShowCutOnly ( bool flag )

Deprecated:

Specifies the switching state of the cut plane.

Parameters

flag	True=1 : Displays the cut part only False=0 : Displays the cross-section

void CutPlane::SetUseCircumferentialDivisions ( bool use )

Specifies whether to use the number of circumferential divisions of the cut cylinder.

Parameters

use	Whether or not to use the the number of circumferential divisions

bool CutPlane::UseCircumferentialDivisions ( )

Returns whether to use the number of circumferential divisions of the cut cylinder.

Returns: Whether or not to use the the number of circumferential divisions

Public Member Functions

Detailed Description

Member Function Documentation