Public Member Functions | List of all members
RevolveSolid Class Reference

RevolveSolid Class
The commands in the RevolveSolid 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 value of an angle for extruding a solid in a radial direction. More...
 
ReferenceObjectGetAxis ()
 Returns rotation axis for extruding a solid in radial direction. 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...
 
bool GetMerge ()
 Returns whether or not to merge with an existing geometry. 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 extrude solids. More...
 
int GetType ()
 Returns True or False as the value for the type of extrusion. More...
 
String GetTypeAsString ()
 Returns the type of extrusion to revolve a solid 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 an angle for extruding a solid a radial direction. More...
 
void SetAxis (ReferenceObject *axis)
 Specifies a rotation axis. More...
 
void SetData (ReferenceObject *axis, double height, bool reverse)
 Specifies the rotation axis, angle of revolve extrude and whether or not to reverse the direction of revolve extrude. More...
 
void SetMerge (bool value)
 Specifies whether or not to merge with an existing geometry. 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 True or False as the value for the type of extrusion. More...
 
void SetTypeByName (String &value)
 Specifies True or False as the value for the type of extrusion. More...
 

Detailed Description

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

The RevolveSolid 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 RevolveSolid::GetAngle ( )

Returns value of an angle for extruding a solid in a radial direction.

Returns
Angle
ReferenceObject * RevolveSolid::GetAxis ( )

Returns rotation axis for extruding a solid in radial direction.

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
bool RevolveSolid::GetMerge ( )

Returns whether or not to merge with an existing geometry.

Returns
Whether or not to merge
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 RevolveSolid::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 * RevolveSolid::GetSketch ( )

Returns a sketch that is used to extrude solids.

Returns
Sketch object
int RevolveSolid::GetType ( )

Returns True or False as the value for the type of extrusion.

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

Returns the type of extrusion to revolve a solid as a string.

Returns
BothSide : 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 RevolveSolid::SetAngle ( double  value)

Specifies an angle for extruding a solid a radial direction.

Parameters
valueAngle
void RevolveSolid::SetAxis ( ReferenceObject axis)

Specifies a rotation axis.

Parameters
axisReferenceObject object
void RevolveSolid::SetData ( ReferenceObject axis,
double  angle,
bool  reverse 
)

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

Parameters
axisRotation axis
angleAngle of revolve extrude
reverse
True=1 : reverse
False=0 : Do not reverse
Deprecated:
Please use SetProperty().
void RevolveSolid::SetMerge ( bool  value)

Specifies whether or not to merge with an existing geometry.

Parameters
value
True=on : Merge
False=off : Do not merge
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 RevolveSolid::SetReverse ( bool  value)

Specifies whether or not to reverse the direction.

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

Specifies True or False as the value for the type of extrusion.

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

Specifies True or False as the value for the type of extrusion.

Parameters
value
BothSide : Both sides
OneSide : One side