Chemical Data Processing Library Python API - Version 1.4.0
Public Member Functions | Properties | List of all members
CDPL.Shape.GaussianShape.Element Class Reference

A single sphere of the Gaussian shape, characterized by a position, radius, hardness and color. More...

+ Inheritance diagram for CDPL.Shape.GaussianShape.Element:

Public Member Functions

None __init__ (Element elem)
 Initializes a copy of the Element instance elem. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Element assign (Element elem)
 Replaces the current state of self with a copy of the state of the Element instance elem. More...
 
None setPosition (Math.Vector3D pos)
 Sets the position of the sphere center. More...
 
Math.Vector3D getPosition ()
 Returns the position of the sphere center. More...
 
None setRadius (float radius)
 Sets the sphere radius. More...
 
float getRadius ()
 Returns the sphere radius. More...
 
None setColor (int color)
 Sets the color attribute of the sphere. More...
 
int getColor ()
 Returns the color attribute of the sphere. More...
 
None setHardness (float hardness)
 Sets the hardness of the Gaussian. More...
 
float getHardness ()
 Returns the hardness of the Gaussian. More...
 

Properties

 objectID = property(getObjectID)
 
 radius = property(getRadius, setRadius)
 
 color = property(getColor, setColor)
 
 hardness = property(getHardness, setHardness)
 
 position = property(getPosition, setPosition)
 

Detailed Description

A single sphere of the Gaussian shape, characterized by a position, radius, hardness and color.

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Shape.GaussianShape.Element.__init__ ( Element  elem)

Initializes a copy of the Element instance elem.

Parameters
elemThe Element instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Shape.GaussianShape.Element.getObjectID ( )

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python Element instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two Element instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns
The numeric ID of the internally referenced C++ class instance.

◆ assign()

Element CDPL.Shape.GaussianShape.Element.assign ( Element  elem)

Replaces the current state of self with a copy of the state of the Element instance elem.

Parameters
elemThe Element instance to copy.
Returns
self

◆ setPosition()

None CDPL.Shape.GaussianShape.Element.setPosition ( Math.Vector3D  pos)

Sets the position of the sphere center.

Parameters
posThe sphere center position.

◆ getPosition()

Math.Vector3D CDPL.Shape.GaussianShape.Element.getPosition ( )

Returns the position of the sphere center.

Returns
The sphere center position.

◆ setRadius()

None CDPL.Shape.GaussianShape.Element.setRadius ( float  radius)

Sets the sphere radius.

Parameters
radiusThe sphere radius.

◆ getRadius()

float CDPL.Shape.GaussianShape.Element.getRadius ( )

Returns the sphere radius.

Returns
The sphere radius.

◆ setColor()

None CDPL.Shape.GaussianShape.Element.setColor ( int  color)

Sets the color attribute of the sphere.

Parameters
colorThe color attribute.

◆ getColor()

int CDPL.Shape.GaussianShape.Element.getColor ( )

Returns the color attribute of the sphere.

Returns
The color attribute.

◆ setHardness()

None CDPL.Shape.GaussianShape.Element.setHardness ( float  hardness)

Sets the hardness of the Gaussian.

Parameters
hardnessThe Gaussian hardness.

◆ getHardness()

float CDPL.Shape.GaussianShape.Element.getHardness ( )

Returns the hardness of the Gaussian.

Returns
The Gaussian hardness.