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

A data type for the descripton of arbitrary shapes composed of spheres approximated by gaussian functions. More...

+ Inheritance diagram for CDPL.Shape.GaussianShape:

Classes

class  Element
 

Public Member Functions

None __init__ ()
 Initializes the GaussianShape instance.
 
None __init__ (GaussianShape shape)
 Initializes a copy of the GaussianShape instance shape. More...
 
GaussianShape assign (GaussianShape shape)
 Replaces the current state of self with a copy of the state of the GaussianShape instance shape. More...
 
None clear ()
 
int getNumElements ()
 
None addElement (Math.Vector3D pos, float radius, int color=0, float hardness=2.7)
 
None addElement (Element elem)
 
None removeElement (int idx)
 
Element getElement (int idx)
 
Base.Any __getitem__ (Base.LookupKey key)
 
Element __getitem__ (int idx)
 
bool __contains__ (Base.LookupKey key)
 Returns the result of the membership test operation key in self. More...
 
None __setitem__ (Base.LookupKey key, Base.Any value)
 
bool __delitem__ (Base.LookupKey key)
 
None __delitem__ (int idx)
 
int __len__ ()
 
- Public Member Functions inherited from CDPL.Base.PropertyContainer
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getNumProperties ()
 Returns the number of property entries. More...
 
Any getPropertyOrDefault (LookupKey key, Any def_value)
 
list getPropertyKeys ()
 
list getPropertyValues ()
 
list getProperties ()
 Returns a reference to itself. More...
 
None setProperty (LookupKey key, Any value)
 
bool removeProperty (LookupKey key)
 Clears the value of the property specified by key. More...
 
Any getProperty (LookupKey key, bool throw_=False)
 Returns the value of the property specified by key. More...
 
bool isPropertySet (LookupKey key)
 Tells whether or not a value has been assigned to the property specified by key. More...
 
None clearProperties ()
 Clears all property values.
 
None addProperties (PropertyContainer cntnr)
 Adds the property value entries in the PropertyContainer instance cntnr. More...
 
None copyProperties (PropertyContainer cntnr)
 Replaces the current set of properties by a copy of the entries in cntnr. More...
 
None swap (PropertyContainer cntnr)
 Exchanges the properties of this container with the properties of the container cntnr. More...
 
Any __getitem__ (LookupKey key)
 
bool __contains__ (LookupKey key)
 Returns the result of the membership test operation key in self. More...
 
None __setitem__ (LookupKey key, Any value)
 
bool __delitem__ (LookupKey key)
 

Additional Inherited Members

- Properties inherited from CDPL.Base.PropertyContainer
 objectID = property(getObjectID)
 
 propertyKeys = property(getPropertyKeys)
 
 propertyValues = property(getPropertyValues)
 
 properties = property(getProperties)
 
 numProperties = property(getNumProperties)
 

Detailed Description

A data type for the descripton of arbitrary shapes composed of spheres approximated by gaussian functions.

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Shape.GaussianShape.__init__ ( GaussianShape  shape)

Initializes a copy of the GaussianShape instance shape.

Parameters
shapeThe GaussianShape instance to copy.

Member Function Documentation

◆ assign()

GaussianShape CDPL.Shape.GaussianShape.assign ( GaussianShape  shape)

Replaces the current state of self with a copy of the state of the GaussianShape instance shape.

Parameters
shapeThe GaussianShape instance to copy.
Returns
self

◆ getNumElements()

int CDPL.Shape.GaussianShape.getNumElements ( )
Returns

◆ addElement() [1/2]

None CDPL.Shape.GaussianShape.addElement ( Math.Vector3D  pos,
float  radius,
int   color = 0,
float   hardness = 2.7 
)
Parameters
pos
radius
color
hardness

◆ addElement() [2/2]

None CDPL.Shape.GaussianShape.addElement ( Element  elem)
Parameters
elem

◆ removeElement()

None CDPL.Shape.GaussianShape.removeElement ( int  idx)
Parameters
idx

◆ getElement()

Element CDPL.Shape.GaussianShape.getElement ( int  idx)
Parameters
idx
Returns

◆ __getitem__() [1/2]

Base.Any CDPL.Shape.GaussianShape.__getitem__ ( Base.LookupKey  key)
Parameters
key
Returns

◆ __getitem__() [2/2]

Element CDPL.Shape.GaussianShape.__getitem__ ( int  idx)
Parameters
idx
Returns

◆ __contains__()

bool CDPL.Shape.GaussianShape.__contains__ ( Base.LookupKey  key)

Returns the result of the membership test operation key in self.

Parameters
keyThe value to test for membership.
Returns
The result of the membership test operation.

◆ __setitem__()

None CDPL.Shape.GaussianShape.__setitem__ ( Base.LookupKey  key,
Base.Any  value 
)
Parameters
key
value

◆ __delitem__() [1/2]

bool CDPL.Shape.GaussianShape.__delitem__ ( Base.LookupKey  key)
Parameters
key
Returns

◆ __delitem__() [2/2]

None CDPL.Shape.GaussianShape.__delitem__ ( int  idx)
Parameters
idx

◆ __len__()

int CDPL.Shape.GaussianShape.__len__ ( )
Returns

Reimplemented from CDPL.Base.PropertyContainer.