Index
Propertie & Method Index
-
[Index] Atom
-
Remark: An Atom object defines a chemical atom, which can be
got from Atoms, Bond.
-
Members
-
[Index] Atoms
-
Remark: An Atoms object is a collection of many atoms, which
can be got from Chem3D, Groups,
Selection.
-
Members
-
[Index] Bond
-
Remark: A Bond object defines a chemical bond, which can be
get from Bonds.
-
Members
-
[Index] Bonds
-
Remark: A Bonds object is a collection of many bonds, which
can be got from Chem3D, Groups,
Selection.
-
Members
-
[Index] Chem3D
-
Remark: Chem3D ActiveX/Plugin's main object. It's
also a window object.
-
Members
-
[Index] DisplyOption
-
Remark: DisplayOption controls Atom's,
Bond's, Group's display option, such as color,
display mode, visibility etc.
-
Members
-
[Index] Group
-
Remark: Chem3D organizes data in a tree-like structure.
Atoms and bonds owned by a group; a group might be owned by another group -
called parent group. Group can be got from Groups.
-
Members
-
[Index] Groups
-
Remark: Groups is a collection of many groups, which can be
got from Chem3D, Group.
-
Members
-
[Index] Measurement
-
Remark: Measurement is a kind of auxiliary element which used
to indicate a distance of two atoms, an angle composed of three atoms or a
dihedral angle composed of four atoms. For a distance, only the Atom1 and
Atom2 are used; for an angle, only Atom1, Atom2 and Atom3 are used. You
can create a measurement from Measurements.
And you can delete a measurement by call its Delete
method.
-
Members
-
[Index] Measurements
-
Remark: Measurements is a collection of many
Measurement.
-
Members
-
[Index] Orbital
-
Remark: For a molecular orbital Surface,
it owns many orbitals. This object define those orbitals.
-
Members
-
[Index] Orbitals
-
Remark: An Orbitals is a collection of many orbitals, which
can be got from Surface.
-
Members
-
[Index] OcxPoint3D
-
Remark: An OcxPoint3D is a coordinates of an Atom.
-
Members
-
[Index] Selection
-
Remark: Selection object defines all selected objects.
-
Members
-
[Index] Settings
-
Remark: A Settings object defines all model setting.
-
Members
-
[Index] Surface
-
Remark: A Surface object defines a molecular surface.
-
Members
-
[Index] Surfaces
-
Remark: A collection of many Surface.
-
Members
Propertie & Method Details
-
[Index] Atom::Display
-
Property: Read Only
-
Remark: Get atom's display setting object, with which you
can change atom's visibility, color, display mode etc.
-
Return: [ DisplyOption
]
-
Parameters: None
-
[Index] Atom::Element
-
Property: Read Only
-
Remark: Get atom's element symbol.
-
Return: [ string ]
-
Parameters: None
-
[Index] Atom::ParentGroup
-
Property: Read Only
-
Remark: Get atom's parent group, with which you can access
group properties.
-
Return: [ Group
]
-
Parameters: None
-
[Index] Atom::Selected
-
Property: Read/Write
-
Remark: Indicate wheather the atom is selected by users.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Atom::SN
-
Property: Read/Write
-
Remark: Get atom's serial number.
-
Return: [ int ]
-
Parameters: None
-
[Index] Atoms::Count
-
Property: Read Only
-
Remark: Get atom count in this collection.
-
Return: [ int ]
-
Parameters: None
-
[Index] Atoms::Item
-
Property: Read Only
-
Remark: Get an atom by an index.
-
Return: [ Atom
]
-
Parameters
-
[Index] Bond::Atom1
-
Property: Read Only
-
Remark: Get the first atom connected to this bond.
-
Return: [ Atom
]
-
Parameters: None
-
[Index] Bond::Atom2
-
Property: Read Only
-
Remark: Get the second atom connected to this bond.
-
Return: [ Atom
]
-
Parameters: None
-
[Index] Bond::BondLength
-
Property: Read Only
-
Remark: Get the bond length.
-
Return: [ double ]
-
Parameters: None
-
[Index] Bond::Display
-
Property: Read Only
-
Remark: Get bond's display setting object, with which you
can change bond's visibility, color, display mode etc.
-
Return: [ DisplyOption
]
-
Parameters: None
-
[Index] Bond::ParentGroup
-
Property: Read Only
-
Remark: Get bond's parent group with which you can access
group properties.
-
Return: [ Group
]
-
Parameters: None
-
[Index] Bond::Selected
-
Property: Read/Write
-
Remark: Indicate whether the bond is selected by users.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Bonds::Count
-
Property: Read Only
-
Remark: Get the bond count of the bond collection.
-
Return: [ int ]
-
Parameters: None
-
[Index] Chem3D::AutoRedraw
-
Property: Read/Write
-
Remark: Indicate whether Chem3D ActiveX/Plugin works in
AutoRedraw mode. If working in AutoRedraw mode, when programatically
change something about this model, the control automatically redraw
itself. If working in non-AutoRedraw mode, you have to manually call
Redraw methods to redraw the control.
AutoRedraw is set to true by default.
In order to improve the code effeciency, you can turn this flag off and
manually call Redraw. This is espcially
useful when you want to call several control motheds at one time to avoid some
flickers.
-
Return: [ boolean ]
-
Parameters: None
-
See Also: Redraw
-
[Index] Chem3D::Clear
()
-
Remark: Clear everything in the control.
-
Return: None
-
Parameters: None
-
[Index] Chem3D::DataURL [Pro]
-
Property: Read/Write
-
Remark: Load a data file into the control. You also
can use a direct data by following format:
data:[{mimetype},]{data}
{mimetype} is the data's mimetype; {data} is the actual data. For
example:
data:chemical/x-smiles,CCCCCC
If the control's MimeType property is set, you
can ignore {mimetype} here. For example:
data:CCCCCC
-
Return: [ string ]
-
Parameters: None
-
See Also: Data
-
[Index] Chem3D::Display
-
Property: Read Only
-
Remark: Get a display object with which you can control
the display setting of the whole model.
-
Return: [ DisplyOption
]
-
Parameters: None
-
[Index] Chem3D::Fullscreen
-
Property: Read/Write
-
Remark: Switch display between fullscreen mode and
normal window mode.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Chem3D::Groups [Pro]
-
Property: Read Only
-
Remark: Get the root-level groups in a group
colloection. Chem3D organizes data in a tree structure. Each node
is a group. Atoms and bonds can locate at any group.
-
Return: [ Groups
]
-
Parameters: None
-
[Index] Chem3D::IsProgrammable
-
Property: Read Only
-
Remark: Chem3D ActiveX/Plugin has two version Pro and
Net. With Net version, you can only change model's display
setting. Pro is the full feature version. Pro returns true for this
property and Net returns false.
-
Return: [ boolean ]
-
Parameters: None
-
See Also: Version
-
[Index] Chem3D::Modified
-
Property: Read/Write
-
Remark: Indicate whether the model is changed by users.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Chem3D::PlayDemo
(double axis_x1, double axis_y1, double axis_z1, double axis_x2, double
axis_y2, double axis_z2, int degree, int amplitude)
-
Remark: Playing a demo means rotate the model around an
axis defined by (x1, y1, z1)-(x2, y2, z2). Rotating speed is controlled
by degree. A negative degree means rotating at the other direct. If
amplitude is 0, it does spin, or does swing with the amplitude.
-
Return: None
-
Parameters
-
axis_x1: [ double ]
-
axis_y1: [ double ]
-
axis_z1: [ double ]
-
axis_x2: [ double ]
-
axis_y2: [ double ]
-
axis_z2: [ double ]
-
degree: [ double ]
-
amplitude: [ double ]
-
See Also: PlayMovie,
Spin, Rotaion, Stop
-
[Index] Chem3D::PlayMovie
()
-
Remark: A Chem3D model might be saved in multiple
frames. We call this kind model a movie. You can play it back by
call this method.
-
Return: None
-
Parameters: None
-
See Also: PlayDemo, Spin,
Stop
-
[Index] Chem3D::Rotation
-
Property: Read/Write
-
Remark: This is a design-time property. At runtime it
does nothing. It works like PlayDemo. You can combine "x", "y", "z"
and two numbers together for this property. It call
PlayDemo at this format:
PlayDemo(0, 0, 0, x, y, z,
degree, 0)
The first number is for degree, and the second for amplitude. You can
ignore any parameter. "x", "y", "z" default to 0, degree default to 1.0,
amplitude default to 0. If amplitude is 0, it does spin, or swing with the
amplitude. For example, "x5" means PlayDemo(0, 0, 0, 1, 0, 0, 5, 0); "x0.5 30"
means PlayDemo(0, 0, 0, 1, 0, 0, 0.5, 30); "xz" means PlayDemo(0, 0, 0, 1, 0,
1, 1, 0); "10" means PlayDemo(0, 0, 0, 0, 1, 0, 10, 0);
You can even use "true" or "false". "true" means PlayDemo(0, 0, 0, 0, 1,
0, 1).
-
Return: [ string ]
-
Parameters: None
-
See Also: PlayDemo
-
[Index] Chem3D::SetControlParameter
(string pParamName, string pParamStringVal, long paramIntVal)
-
Remark: CambridgeSoft reserved.
-
Return: [ boolean ]
-
Parameters
-
pParamName: [ string ]
-
pParamStringVal: [ string ]
-
paramIntVal: [ long ]
-
[Index] Chem3D::Settings
-
Property: Read Only
-
Remark: Get a Settings object with which you can change
something like background color, label color, perspective mode etc.
-
Return: [ Settings
]
-
Parameters: None
-
[Index] Chem3D::ShowContextMenu
-
Property: Read/Write
-
Remark: Indicate whether allow users right-click to access
context menu.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Chem3D::Spin
(double axis_x1, double axis_y1, double axis_z1, double axis_x2, double
axis_y2, double axis_z2, int degree)
-
Remark: Spin the model around axis (x1, y1, z1)-(x2, y2,
z2) to make a movie.
-
Return: None
-
Parameters
-
axis_x1: [ double ]
-
axis_y1: [ double ]
-
axis_z1: [ double ]
-
axis_x2: [ double ]
-
axis_y2: [ double ]
-
axis_z2: [ double ]
-
degree: [ double ]
-
See Also: PlayMovie,
PlayDemo, Stop
-
[Index] Chem3D::Version
-
Property: Read Only
-
Remark: Get the control's version string. For
example: "Chem3D Pro Control 10.0".
-
Return: [ string ]
-
Parameters: None
-
See Also: IsProgrammable
-
[Index] DisplyOption::Color
-
Property: Read/Write
-
Remark: Object's RGB color. It's an integer.
-
Return: [ ColorRGB ]
-
Parameters: None
-
[Index] DisplyOption::UseDefaultColor
-
Property: Read/Write
-
Remark: Indicate not to use the color defined in Color
property, but use object's parent color.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Group::Atoms
-
Property: Read Only
-
Remark: Get an atom collection owned by this group.
-
Return: [ Atoms
]
-
Parameters: None
-
[Index] Group::Bonds
-
Property: Read Only
-
Remark: Get a bond collection owned by this group.
-
Return: [ Bonds
]
-
Parameters: None
-
[Index] Group::Display
-
Property: Read Only
-
Remark: Get a display object with which you can change the
group's display option.
-
Return: [ DisplyOption
]
-
Parameters: None
-
[Index] Group::Groups
-
Property: Read Only
-
Remark: Get a child group collection owned by this group.
-
Return: [ Groups
]
-
Parameters: None
-
[Index] Group::Name
-
Property: Read Only
-
Remark: Get the group's name.
-
Return: [ string ]
-
Parameters: None
-
[Index] Group::Selected
-
Property: Read/Write
-
Remark: Indicate whether this group is selected.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Groups::Count
-
Property: Read Only
-
Remark: Get the group count.
-
Return: [ int ]
-
Parameters: None
-
[Index] Measurement::Atom3
-
Property: Read Only
-
Remark: The third atom composes the measurement. For
a distance composed of two atoms, this property always return null.
-
Return: [ Atom
]
-
Parameters: None
-
[Index] Measurement::Atom4
-
Property: Read Only
-
Remark: The fourth atom composes the measurement.
For a distance composed of two atoms and an angle composed of three atoms, this
property always return null.
-
Return: [ Atom
]
-
Parameters: None
-
[Index] Measurement::Value
-
Property: Read/Write
-
Remark: Get the actual measured value: a distance, an
angle or a dihedral angle.
-
Return: [ double ]
-
Parameters: None
-
[Index] Orbital::Energy
-
Property: Read Only
-
Remark: Get the energy of a molecular orbital.
-
Return: [ double ]
-
Parameters: None
-
[Index] Orbital::Label
-
Property: Read Only
-
Remark: Get the lable of a molecular orbital.
-
Return: [ string ]
-
Parameters: None
-
[Index] Orbital::Type
-
Property: Read Only
-
Remark: Get the type of a molecular orbital. It
could be HOMO, LUMO or unknown.
-
Return: [ OrbitalTypes
]
-
Parameters: None
-
[Index] Orbitals::Count
-
Property: Read Only
-
Remark: Get the orbital count.
-
Return: [ int ]
-
Parameters: None
-
[Index] OcxPoint3D::X
-
Property: Read/Write
-
Remark: X coordinate.
-
Return: [ double ]
-
Parameters: None
-
[Index] OcxPoint3D::Y
-
Property: Read/Write
-
Remark: Y coordinate.
-
Return: [ double ]
-
Parameters: None
-
[Index] OcxPoint3D::Z
-
Property: Read/Write
-
Remark: Z coordinate.
-
Return: [ double ]
-
Parameters: None
-
[Index] Selection::Atoms
-
Property: Read Only
-
Remark: Get an atom collection which include all selected
atoms.
-
Return: [ Atoms
]
-
Parameters: None
-
[Index] Selection::Bonds
-
Property: Read Only
-
Remark: Get a bond collection which include all selected
bonds.
-
Return: [ Bonds
]
-
Parameters: None
-
[Index] Settings::AlphaHelixColor
-
Property: Read/Write
-
Remark: Get and set alpha helix color for biological
molecules. This is used only when DisplayMode
set to Ribbons or Cartoons.
-
Return: [ ColorRGB ]
-
Parameters: None
-
[Index] Settings::BetaSheetColor
-
Property: Read/Write
-
Remark: Get and set beta sheet color for biological molecules.
This is used only when DisplayMode
set to Ribbons or Cartoons.
-
Return: [ ColorRGB ]
-
Parameters: None
-
[Index] Settings::CoilColor
-
Property: Read/Write
-
Remark: Get and set coil color for biological molecules. This
is used only when DisplayMode
set to Ribbons or Cartoons.
-
Return: [ ColorRGB ]
-
Parameters: None
-
[Index] Settings::DepthFading
-
Property: Read/Write
-
Remark: Indicate whether show model in depth-fading mode.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Settings::NucliecAcidColor
-
Property: Read/Write
-
Remark: Get and set nucliec acid color for biological
molecules. This is used only when DisplayMode
set to Ribbons or Cartoons.
-
Return: [ ColorRGB ]
-
Parameters: None
-
[Index] Settings::Perspective
-
Property: Read/Write
-
Remark: Indicate whether show model in perspective mode.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Settings::ShowRedBlue
-
Property: Read/Write
-
Remark: Indicate whether show model in red-blue mode.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Surface::Color
-
Property: Read/Write
-
Remark: Get and set surface's color.
-
Return: [ ColorRGB ]
-
Parameters: None
-
[Index] Surface::Color2
-
Property: Read/Write
-
Remark: Get and set surface's second color. When a surface has
two sections, e.g. a molecular surface has positive and negative parts,
Color
and Color2 are both used to specify the surface's color.
-
Return: [ ColorRGB ]
-
Parameters: None
-
[Index] Surface::Orbitals
-
Property: Read Only
-
Remark: Get an orbital collection including all molecular
orbitals.
-
Return: [ Orbitals
]
-
Parameters: None
-
[Index] Surface::Radius
-
Property: Read/Write
-
Remark: Get and set the detecting probe's radius to
producing the surface.
-
Return: [ double ]
-
Parameters: None
-
[Index] Surface::Resolution
-
Property: Read/Write
-
Remark: Get and set the surface's resolution.
-
Return: [ int ]
-
Parameters: None
-
[Index] Surface::Visible
-
Property: Read/Write
-
Remark: Indicate the surface's visibility.
-
Return: [ boolean ]
-
Parameters: None
-
[Index] Surfaces::Count
-
Property: Read Only
-
Remark: Get the surface count.
-
Return: [ int ]
-
Parameters: None
Chem3D ActiveX/Plugin Customized Type
-
[Index] BackgroundEffects
-
Solid
-
Sunrise
-
Sunset
-
SunsetOverSea
-
SeaAndSky
-
Left
-
Right
-
Middle
-
DualSides
-
DiagonalUpRight
-
DiagonalDownLeft
-
DiagonalSlash
-
ReversedSlash
-
DiagonalUpLeft
-
DiagonalDownRight
-
Backslash
-
ReversedBackslash
-
DownLeftCorner
-
DownRightCorner
-
UpRightCorner
-
UpLeftCorner
-
Diamond
-
ReversedDiamond
-
[Index] SurfaceMappingColor
-
MapMonochrome
-
MapAtomColor
-
MapElementColor
-
MapGroupColor
-
MapHydrophobicColor
-
MapPartialChargeColor
-
MapPotentialColor
-
MapSpinDensityColor
-
MapOrbitalColor
[Pro] means
this property or methods is only available for Chem3D Pro ActiveX/Plugin.
You can programmatically detect this by calling Chem3D::IsProgrammable.
[ActiveX] Means
this property or methods is only available for Chem3D ActiveX control, not for
Plugin.
Return to [Index]
|