XCSEditor Class Reference

external coordinate system editor More...

#include <xcs_editor.hh>

Inherits ost::mol::EditorBase.

Public Member Functions
	XCSEditor ()
	~XCSEditor ()
	XCSEditor (const XCSEditor &rhs)
XCSEditor &	operator= (const XCSEditor &rhs)
void	SetAtomOriginalPos (const AtomHandle &atom, const geom::Vec3 &position)
void	SetAtomOriginalPos (const AtomHandleList &alist, float *positions)
void	SetAtomOriginalPos (const AtomHandleList &alist, double *positions)
void	SetAtomTransformedPos (const AtomHandle &atom, const geom::Vec3 &position)
void	SetAtomTransformedPos (const AtomHandleList &alist, float *positions)
void	SetAtomTransformedPos (const AtomHandleList &alist, double *positions)
void	SetAtomPos (const AtomHandle &atom, const geom::Vec3 &position)
void	SetAtomPos (const AtomHandleList &alist, float *positions)
void	SetAtomPos (const AtomHandleList &alist, double *positions)
void	ApplyTransform (const geom::Mat4 &transform)
void	ApplyTransform (const geom::Transform &transform)
void	SetTransform (const geom::Mat4 &transform)
void	SetTransform (const geom::Transform &transform)
void	FixTransform ()
void	UpdateICS ()
void	ForceUpdate ()
Protected Member Functions
	XCSEditor (const EntityHandle &ent, EditMode mode)
void	Update ()
Friends
class	EntityHandle

---

Detailed Description

external coordinate system editor

For an introduction to editors go here.

Definition at line 36 of file xcs_editor.hh.

---

Constructor & Destructor Documentation

XCSEditor

(

)

create invalid xcs editor

~XCSEditor

(

)

XCSEditor

(

const XCSEditor &

rhs

)

XCSEditor	(	const EntityHandle &	ent,
		EditMode	mode
	)			[protected]

---

Member Function Documentation

void ApplyTransform

(

const geom::Transform &

transform

)

void ApplyTransform

(

const geom::Mat4 &

transform

)

apply additional transformation to all atoms

This transformation is applied after the transformation already stored in the entity

void FixTransform

(

)

set transformed pos to new original pos

void ForceUpdate

(

)

force spatial organizer and ics update workaround for delayed dtor call from Python garbage collection

XCSEditor& operator=

(

const XCSEditor &

rhs

)

void SetAtomOriginalPos	(	const AtomHandleList &	alist,
		double *	positions
	)

numpy double interface

the passed in double array must have a length of 3*alist.size()

void SetAtomOriginalPos	(	const AtomHandleList &	alist,
		float *	positions
	)

numpy float interface

the passed in float array must have a length of 3*alist.size()

void SetAtomOriginalPos	(	const AtomHandle &	atom,
		const geom::Vec3 &	position
	)

set original position of atom This function also updates the stores transformed coordinates

void SetAtomPos	(	const AtomHandleList &	alist,
		double *	positions
	)

same as SetTransformedPos(AtomHandleList,double*)

void SetAtomPos	(	const AtomHandleList &	alist,
		float *	positions
	)

same as SetTransformedPos(AtomHandleList,float*)

void SetAtomPos	(	const AtomHandle &	atom,
		const geom::Vec3 &	position
	)

same as SetAtomTransformedPos(AtomHandle, geom::Vec3)

void SetAtomTransformedPos	(	const AtomHandleList &	alist,
		double *	positions
	)

numpy double interface

the passed in double array must have a length of 3*alist.size()

void SetAtomTransformedPos	(	const AtomHandleList &	alist,
		float *	positions
	)

numpy float interface

the passed in float array must have a length of 3*alist.size()

void SetAtomTransformedPos	(	const AtomHandle &	atom,
		const geom::Vec3 &	position
	)

set transformed position of atom

This function also updates the original coordinates

void SetTransform

(

const geom::Transform &

transform

)

void SetTransform

(

const geom::Mat4 &

transform

)

apply a new transformation to all atoms

void Update

(

)

[protected]

void UpdateICS

(

)

immediately update internal coordinate system

---

Friends And Related Function Documentation

friend class EntityHandle [friend]

Definition at line 38 of file xcs_editor.hh.

---

The documentation for this class was generated from the following file:

• stage/include/ost/mol/xcs_editor.hh