Public Member Functions | List of all members
RevolveCut Class Reference

RevolveCut Class
The commands in the RevolveCut 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...
 
double GetAngle ()
 Returns an angle to create a radial extrusion to cut from a sketch. More...
 
ReferenceObjectGetAxis ()
 Returns a rotation axis. More...
 
ItemObjectGetItem (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...
 
bool GetReverse ()
 Returns True as a value when a direction is reversed. More...
 
String GetScriptTypeName ()
 Returns the name of the object type as a string. More...
 
SketchGetSketch ()
 Returns a sketch that is used to create a radial extrusion. More...
 
int GetType ()
 Returns a value for the type of revolution cut. More...
 
String GetTypeAsString ()
 Returns the type of revolution cut as a string. More...
 
virtual bool IsValid ()
 Returns True if an object is valid. More...
 
int NumItems ()
 Returns the number of items. More...
 
void SetAngle (double value)
 Specifies the angle to create a radical extrusion. More...
 
void SetAxis (ReferenceObject *axis)
 Selects a rotation axis. More...
 
void SetData (ReferenceObject *axis, double height, bool reverse)
 Specifies the rotation axis, angle of revolve cut and whether or not to reverse the direction of revolve cut. More...
 
void SetName (String &name)
 Specifies a name. 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 SetReverse (bool value)
 Specifies whether or not to reverse the direction. More...
 
void SetType (int value)
 Specifies a value for the type of revolution cut. More...
 
void SetTypeByName (String &value)
 Specifies the string for a type of revolution cut. More...
 

Detailed Description

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

The RevolveCut class includes the commands for the following operation.

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
nameProperty name
valueReferenceObject object (target)
double RevolveCut::GetAngle ( )

Returns an angle to create a radial extrusion to cut from a sketch.

Returns
Angle
ReferenceObject * RevolveCut::GetAxis ( )

Returns a rotation axis.

Returns
ReferenceObject object (Object for rotation axis)
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
valueItem 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
nameProperty name
Returns
Value of properties
bool RevolveCut::GetReverse ( )

Returns True as a value when a direction is reversed.

Returns
Returns True when a direction is reversed.
String ItemObject::GetScriptTypeName ( )
inherited

Returns the name of the object type as a string.

Returns
Type name of object
Sketch * RevolveCut::GetSketch ( )

Returns a sketch that is used to create a radial extrusion.

Returns
Sketch object
int RevolveCut::GetType ( )

Returns a value for the type of revolution cut.

Returns
True=1 : Both sides
False=0 : One side
String RevolveCut::GetTypeAsString ( )

Returns the type of revolution cut as a string.

Returns
BothSides : Both sides
OneSide : One side
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 RevolveCut::SetAngle ( double  value)

Specifies the angle to create a radical extrusion.

Parameters
valueAngle
void RevolveCut::SetAxis ( ReferenceObject axis)

Selects a rotation axis.

Parameters
axisReferenceObject object (Object for rotation axis)
void RevolveCut::SetData ( ReferenceObject axis,
double  angle,
bool  reverse 
)

Specifies the rotation axis, angle of revolve cut and whether or not to reverse the direction of revolve cut.

Parameters
axisRotation axis
angleAngle of revolve cut
reverse
True=1 : reverse
False=0 : Do not reverse
Deprecated:
Please use SetProperty().
void ItemObject::SetName ( String &  name)
inherited

Specifies a name.

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

Specifies a value of property.

Parameters
nameProperty name
valueValue of properties

Reimplemented in SketchItem.

void ItemObject::SetPropertyByReference ( String &  name,
ReferenceObject value 
)
virtualinherited

Specifies the values in properties by ReferenceObject object.

Parameters
nameProperty name
valueReferenceObject object (target)
void RevolveCut::SetReverse ( bool  value)

Specifies whether or not to reverse the direction.

Parameters
value
True=on : Reverse
False=off : Do not reverse
void RevolveCut::SetType ( int  value)

Specifies a value for the type of revolution cut.

Parameters
value
True=1 : Both sides
False=0 : One side
void RevolveCut::SetTypeByName ( String &  value)

Specifies the string for a type of revolution cut.

Parameters
value
BothSides : Both sides
OneSide : One side