Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescription
setPointerInternal use.
Cobject#freeDestroys the object.
getNameGets object name.
setNameSets object name.
isMeshChecks whether the object is a mesh.
isInstanceChecks whether the object is an instance.
getInstancedGets instance's parent.
isRFRKChecks whether the object is a RFRK object.
getRFRKParametersGets ReaFlow RenderKit parameters.
setRFRKParametersSets ReaFlow RenderKit  parameters.
getReferencedScenePathGets the scene file referenced by this object.
setReferencedScenePathSets the scene file referenced by this object.
getReferencedSceneMaterialGets the material of an specific object inside the referenced scene.
setReferencedSceneMaterialSets the material of an specific object inside the referenced scene.
getReferencedOverrideFlagsGet the override policy for visibility flags.
setReferencedOverrideFlagsSet the override policy for visibility flags.
mergeMeshesMerges an array of meshes into a single mesh. Target object must not be included.
getParentGets the parent object in the hierarchy.
setParentSets the parent object in the hierarchy.
getUuidUnique user ID that can be used for custom purposes.
setUuidSets the unique user ID.
getMaterialGets the material applied.
setMaterialSets the object material.
setPropertiesSets the caustics properties of the object.

getDependencies

Gets all the extern dependencies of the object (rfrk files, etc).
Geometry
getNumVertexesGets number of vertexes of the object.
getNumTrianglesGets number of triangles of the object.
getNumNormalsGets number of the normals of the object.
getNumPositionsPerVertexGets number of positions per vertex of the object.
getNumChannelsUVWGets number of UVW channels of the object.
addChannelUVWAdds an UVW channel to the object.
generateSphericalUVWGenerates spherical UVW coordinates.
generateCylindricalUVWGenerates cylindrical UVW coordinates.
generateCubicUVWGenerates cubic UVW coordinates.
generatePlanarUVWGenerates planar UVW coordinates.
getVertexGets vertex by index.
setVertexSets vertex by index.
getNormalGets normal by index.
setNormalSets normal by index.
getTriangleGets triangle (vertexes and normals) by index.
setTriangleSets triangle (vertexes and normals) by index.
getTriangleGroupGets triangle group by index.
setTriangleGroupSets triangle group.
getTriangleUVWGets triangle UVW coordinates.
setTriangleUVWSets triangle UVW coordinantes.
getTriangleMaterialGets triangle material.
setTriangleMaterialSets triangle material.
getGroupMaterialGets material of a group of triangles.
setGroupMaterialSets material of a group of triangles.
getBaseAndPivotGets base and pivot axes of the object.
setBaseAndPivotSets base and pivot axes of the object.
getWorldTransformReturn the world transform of the object.
getTransformSubstepsCountReturn the number of substeps used for defining Base and Pivot motion blur.
getTransfrormStepInfoByIndexReturn transform information( base, pivot and time) for the given index.
getPositionUsed by Maxwell Studio (not needed for rendering).
setPositionUsed by Maxwell Studio (not needed for rendering).
getRotationUsed by Maxwell Studio (not needed for rendering).
setRotationUsed by Maxwell Studio (not needed for rendering).
getScaleUsed by Maxwell Studio (not needed for rendering).
setScaleUsed by Maxwell Studio (not needed for rendering).
getShearUsed by Maxwell Studio (not needed for rendering).
setShearUsed by Maxwell Studio (not needed for rendering).
getPivotPositionUsed by Maxwell Studio (not needed for rendering).
setPivotPositionUsed by Maxwell Studio (not needed for rendering).
getPivotRotationUsed by Maxwell Studio (not needed for rendering).
setPivotRotationUsed by Maxwell Studio (not needed for rendering).
isPosRotScaleInitializedChecks if the methods above have been used for the given object.
cleanGeometryOptional routine that removes degenerated triangles, repeated/unused vertex and normals.
Display
getHideGets "hide" status of the object.
setHideSets "hide" status of the object.
getHideToCameraGets "hide to camera" status of the object.
setHideToCameraSets "hide to camera" status of the object.
getHideToReflectionsRefractionsGets "hide to reflections and refractions" status of the object.
setHideToReflectionsRefractionsSets "hide to reflections and refractions" status of the object.
getHideToGIGets "hide to global illumination" status of the object.
setHideToGIGets "hide to global illumination" status of the object.
isExcludedOfCutPlanesGets "excluded of cut planes" status of the object.
excludeOfCutPlanesSets "excluded of cut planes" status of the object.
getReferenceDisplayPointsThis function is useful to display a mesh on a viewport.
setColorIDSets the color used by this object in the Object ID render channel.
getColorIDGets the color used by this object in the Object ID render channel.
setGeometryDirtySet the geometry "dirty".
getUserDataInternal use.
setUserDataInternal use.
getVertexesBufferInternal use.
getNormalsBufferInternal use.
getTrianglesBufferInternal use.
initializeMeshClean the mesh and allocates memory for vertexes, normals, triangles and motion blur.
resizeMeshReinitializes all the basic geometry and UV arrays.
generateCustomUVW--TODO--
getUVWChannelPropertiesGets UVW channel properties.
getGlobalXform--TODO--
getGlobalNormalsXform--TODO--
getInverseGlobalXform--TODO--
getInverseGlobalNormalsXform--TODO--
isGeometryLoaderChecks if the object was created by a geometry loader extension.
isGeometryProceduralChecks if the object was created by a procedural geometry extension.
hasGeometryModifiersChecks if the object has geometry modifiers (extensions).
applyGeometryModifierExtension--TODO--
cleanAllGeometryModifierExtensionsClean all geometry modifier extensions applyed to the object.
getGeometryLoaderExtensionParams--TODO--
getGeometryProceturalExtensionParams--TODO--
getGeometryModifierExtensionsNumberGets the number of geometry modifier extensions applied to the object.
getGeometryModifierExtensionParamsAtIndex--TODO--

...

0 = Error setting reference scene file.

1 = Success.

Anchor
getreferencedoverrideflags
getreferencedoverrideflags

getReferencedOverrideFlags

Gets the override policy for visibility flags. Flags are described in OVERRIDE_REFERENCE_FLAGS in maxwellenums.h.

LanguageSyntax
C++byte getReferencedOverrideFlags( byte& flags )
Python(int flags, int success) getReferencedOverrideFlags()

Return value

C++

0 = Error

1 = Success

Python

Tuple containing the "override reference" flags of the object, and the function success value.

Anchor
setreferencedoverrideflags
setreferencedoverrideflags

setReferencedOverrideFlags

Sets the override policy for visibility flags. Flags are described in OVERRIDE_REFERENCE_FLAGS in maxwellenums.h.

LanguageSyntax
C++byte setReferencedOverrideFlags( byte& flags )
Pythonint setReferencedOverrideFlags( int flags )

Return value

0 = Error

1 = Success

Anchor
mergemeshes
mergemeshes

mergeMeshes

...

LanguageSyntax
C++byte mergeMeshes( const Cmaxwell::Cobject* pMeshes, dword nMeshes )
Pythonint mergeMeshes( CmaxwellObject[] meshes )

Return value

0 = Error setting reference scene file.

...

LanguageSyntax
C++byte getParent( Cmaxwell::Cobject& parent )
PythonCmaxwellObject getParent()

Return value

C++

0 = Error getting parent object.

1 = Success.

Python

Parent object.

Anchor
setparent
setparent

...

LanguageSyntax
C++byte setParent( Cmaxwell::Cobject parent )
Pythonint setParent( CmaxwellObject parent )

Return value

0 = Error setting parent object.

...

LanguageSyntax
C++byte setUuid( const char* pUuid )
Pythonint setUuid( str uuid )

Return value

0 = Error setting unique user ID.

...

LanguageSyntax
C++byte getMaterial( Cmaxwell::Cmaterial& parent )
PythonCmaxwellMaterial  getMaterial()

Return value

C++

0 = Error getting object material.

1 = Success.

Python

Object material.

Anchor
setmaterial
setmaterial

...

LanguageSyntax
C++byte setMaterial( Cmaxwell::Cmaterial material )
Pythonint setMaterial( CmaxwellMaterial  material )

Return value

0 = Error setting object material.

...

LanguageSyntax
C++byte setProperties( int doDirectCausticsReflection, int doDirectCausticsRefraction, int doIndirectCausticsReflection, int doIndirectCausticsRefraction )
Pythonint setProperties( byte doDirectCausticsReflection, byte doDirectCausticsRefraction, byte doIndirectCausticsReflection, byte doIndirectCausticsRefraction )

Return value

0 = Error setting object material.

...

TypeNameIn/OutDescription
dword&numDependenciesout(C++ only) Number of dependencies returned.
char**&pathsout(C++ onlu) String array (size = numDependencies) containing all the dependencies requested.
const bool&searchIndideProxyin

If true, the function search for dependencies also in the referenced proxy objects if exists. searchInsideProxy is true by default.

Return value

C++

0 = Error getting dependency paths.

1 = Success.

Python

List of str containing the dependency paths.

...

LanguageSyntax
C++byte getNumVertexes( dword& nVertexes )
Pythonint getNumVertexes()

Return value

C++

0 = Error getting number of vertexes.

1 = Success.

Python

Number of vertexes.

Anchor
getnumtriangles
getnumtriangles

...

LanguageSyntax
C++byte getNumTriangles( dword& nTriangles )
Pythonint getNumTriangles()

Return value

C++

0 = Error getting number of triangles.

1 = Success.

Python

Number of triangles.

Anchor
getnumnormals
getnumnormals

...

LanguageSyntax
C++byte getNumNormals( dword& nNormals )
Pythonint getNumNormals()

Return value

C++

0 = Error getting number of normals.

1 = Success.

Python

Number of normals.

Anchor
getnumpositionspervertex
getnumpositionspervertex

...

LanguageSyntax
C++byte getNumPositionsPerVertex( dword& nPositions )
Pythonint getNumPositionsPerVertex()

Return value

C++

0 = Error getting number of positions per vertex.

1 = Success.

Python

Number of positions per vertex.

...

LanguageSyntax
C++byte getNumChannelsUVW( dword& nChannelsUVW )
Pythonint getNumChannelsUVW()

Return value

C++

0 = Error getting number UVW channels.

1 = Success.

Python

Number of UVW channels.

Anchor
addchanneluvw
addchanneluvw

...

LanguageSyntax
C++byte addChannelUVW( dword& index, byte id = 0xFF )
Pythonint addChannelUVW( byte id = 0xFF )

Return value

C++

0 = Error adding UVW channel.

1 = Success.

Python

Index of the new channel.

...

LanguageSyntax
C++byte generateSphericalUVW( dword& iChannel, CbaseT& projectorBase, real& startLatitude, real& endLatitude, real& startLongitude, real& endLongitude )
Pythonint generateSphericalUVW( int iChannel, Cbase projectorBase, float startLatitude, float endLatitude, float startLongitude, float endLongitude )

Return value

0 = Error generating spherical UVW coordinaltes.

...

LanguageSyntax
C++byte generateCylindricalUVW( dword& iChannel,  Cbase& projectorBase, real& startAngle, real& endAngle )
Pythonint generateCylindricalUVW( int iChannel,  Cbase projectorBase, float startAngle, float endAngle )

Return value

0 = Error generating cylindrical UVW coordinaltes.

...

LanguageSyntax
C++byte generateCubicUVW( dword& iChannel,  Cbase& projectorBase, bool mirrorBackFaces = false )
Pythonint generateCubicUVW( int iChannel,  Cbase projectorBase, bool mirrorBackFaces = False )

Return value

0 = Error generating cubic UVW coordinaltes.

...

LanguageSyntax
C++byte generatePlanarUVW( dword& iChannel,  Cbase& projectorBase )
Pythonint generatePlanarUVW( int iChannel,  Cbase projectorBase )

Return value

0 = Error generating planar UVW coordinaltes.

...

LanguageSyntax
C++byte getVertex( dword iVertex, dword iPosition, Cpoint& point )
PythonCvector getVertex( int iVertex, int iPosition )

Return value

C++

0 = Error getting the vertex.

1 = Success.

Python

 Cvector containing the vertex requested.

...

LanguageSyntax
C++byte setVertex( dword iVertex, dword iPosition, const Cpoint& point )
Pythonint setVertex( int iVertex, int iPosition, Cvector point )

Return value

0 = Error setting the vertex.

...

LanguageSyntax
C++byte getNormal( dword iVertex, dword iPosition, Cvector&normal )
PythonCvector getNormal( int iVertex, int iPosition )

Return value

C++

0 = Error getting the normal.

1 = Success.

Python

Cvector containing the normal requested.

...

LanguageSyntax
C++byte setNormal( dword iNormal, dword iPosition, const Cvector& normal )
Pythonint setNormal( int iNormal, int iPosition, Cvector normal )

Return value

0 = Error setting the normal.

...

LanguageSyntax
C++

byte getTriangle( dword iTriangle, dword &iVertex1, dword &iVertex2, dword &iVertex3, dword &iNormal1, dword &iNormal2, dword &iNormal3 )

Python

(int iVertex1, int iVertex2, int iVertex3, int iNormal1, int iNormal2, int iNormal3) getTriangle( int iTriangle )

Return value

C++

0 = Error getting the triangle.

1 = Success.

Python

Tuple containing the triangle data.

...

LanguageSyntax
C++byte setTriangle( dword iTriangle, dword iVertex1, dword iVertex2, dword iVertex3, dword iNormal1, dword iNormal2, dword iNormal3 )
Pythonint setTriangle( int iTriangle, int iVertex1, int iVertex2, int iVertex3, int iNormal1, int iNormal2, int iNormal3 )

Return value

0 = Error setting the triangle.

...

LanguageSyntax
C++

byte getTriangleGroup( dword iTriangle, dword& idGroup )

Pythonint getTriangleGroup( int iTriangle )

Return value

C++

0 = Error getting the triangle group.

1 = Success.

Python

Triangle group ID.

Anchor
settrianglegroup
settrianglegroup

...

LanguageSyntax
C++byte setTriangleGroup( dword iTriangle, dword idGroup )
Pythonint setTriangleGroup( int iTriangle, int idGroup )

Return value

0 = Error setting the triangle group.

...

LanguageSyntax
C++

byte getTriangleUVW( dword iTriangle, dword iChannelID, float& u1, float& v1, float& w1, float& u2, float& v2, float& w2, float& u3, float& v3, float& w3 )

Python

(float u1, float v1, float w1, float u2, float v2, float w2, float u3, float v3, float w3) getTriangleUVW( int iTriangle, int iChannelID )

Return value

C++

0 = Error getting the triangle UVW coordinates.

1 = Success.

Python

Tuple containing the triangle UVW coordinates.

...

LanguageSyntax
C++byte setTriangleUVW( dword iTriangle, dword iChannelID, float u1, float v1, float w1, float u2, float v2, float w2, float u3, float v3, float w3 )
Pythonint setTriangleUVW( int iTriangle, int iChannelID, float u1, float v1, float w1, float u2, float v2, float w2, float u2, float v2, float w3 )

Return value

0 = Error setting the triangle UVW coordinates.

...

LanguageSyntax
C++byte getTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial& material )
PythonCmaxwellMaterial getTriangleMaterial( int iTriangle )

Return value

C++

0 = Error getting triangle material.

1 = Success.

Python

Triangle material.

Anchor
settrianglematerial
settrianglematerial

...

LanguageSyntax
C++byte setTriangleMaterial( dword iTriangle, Cmaxwell::Cmaterial material )
Pythonint setTriangleMaterial( int iTriangle, CmaxwellMaterial material )

Return value

0 = Error setting triangle material.

...

LanguageSyntax
C++byte getGroupMaterial( dword iGroup, Cmaxwell::Cmaterial& material )
PythonCmaxwellMaterial getGroupMaterial( int iGroup )

Return value

C++

0 = Error getting triangle group material.

1 = Success.

Python

Triangle group material.

Anchor
setgroupmaterial
setgroupmaterial

...

LanguageSyntax
C++byte setGroupMaterial( dword iGroup, Cmaxwell::Cmaterial material )
Pythonint setGroupMaterial( int iGroup, CmaxwellMaterial material )

Return value

0 = Error setting triangle group material.

...

LanguageSyntax
C++

byte setBaseAndPivot( Cbase base, Cbase pivot, real substepTime = 0.0 )

Pythonint setBaseAndPivot( Cbase base, Cbase pivot, float substepTime = 0.0 )

Return value

0 = Error setting object base and pivot.

...

LanguageSyntax
C++byte getBaseAndPivot( Cbase& base, Cbase& pivot, const real substepTime = 0.0 )
Python(Cbase base, Cbase pivot) getBaseAndPivot( float substepTime = 0.0 )

Return value

C++

0 = Error getting object base and pivot.

1 = Success.

Python

Tuple containing Cbase base and Cbase pivot axes (base,pivot).

...

LanguageSyntax
C++byte getWorldTransform( Cbase& base )
PythonCbase getWorldTransform()

Return value

C++

0 = Error getting world transform of the object.

1 = Success.

Python

Object world transform.

Anchor
gettransformsubstepscount
gettransformsubstepscount

...

LanguageSyntax
C++byte getTransformStepInfoByIndex( Cbase& base, Cbase& pivot, real& time, const dword index )
Python(Cbase base, Cbase pivot, float time) getTransformStepInfoByIndex( int index )

Return value

C++

0 = Error getting transform information of the object.

1 = Success.

Python

Tuple containing transform information.

...

LanguageSyntax
C++byte isPosRotScaleInitialized( bool& init )
Pythonbool isPosRotScaleInitialized()

Return value

C++

0 = Error getting object transformed for Maxwell Studio.

1 = Success.

Python

True = object initialized using setPosition, setRotation, setScale, setShear, setPivotPosition and/or setPivotRotation (methods used for Maxwell Studio, not for rendering.

...

LanguageSyntax
C++byte cleanGeometry()
Pythonint cleanGeometry()

Return value

0 = Error cleaning geometry.

...

LanguageSyntax
C++byte getHide( bool& hide )
Pythonbool getHide()

Return value

C++

0 = Error getting "hide" status.

1 = Success.

Python

True = object is hidden.

False = object is not hidden.

...

LanguageSyntax
C++byte setHide( bool hide )
Pythonint setHide( bool hide )

Return value

0 = Error setting "hide" state.

...

LanguageSyntax
C++byte getHideToCamera( bool& hide )
Pythonbool getHide()

Return value

C++

0 = Error getting "hide to camera" status.

1 = Success.

Python

True = object is hidden to camera.

...

LanguageSyntax
C++byte setHideToCamera( bool hide )
Pythonint setHideToCamera( bool hide )

Return value

0 = Error setting "hide to camera" state.

...

LanguageSyntax
C++byte getHideToReflectionsRefractions( bool& hide )
Pythonbool getHideToReflectionsRefractions()

Return value

C++

0 = Error getting "hide to reflections and refractions" status.

1 = Success.

Python

True = object is hidden to reflections and refractions.

...

LanguageSyntax
C++byte setHideToReflectionsRefractions( bool hide )
Pythonint setHideToReflectionsRefractions( bool hide )

Return value

0 = Error setting "hide to reflections and refractions" state.

...

LanguageSyntax
C++byte getHideToGI( bool& hide )
Pythonbool getHideToGI()

Return value

C++

0 = Error getting "hide to global illumination" status.

1 = Success.

Python

True = object is hidden to global illumination.

...

LanguageSyntax
C++byte setHideToGI( bool hide )
Pythonint setHideToGI( bool hide )

Return value

0 = Error setting "hide to global illumination" state.

...

LanguageSyntax
C++byte isExcludedOfCutPlanes( bool& excluded )
Pythonbool isExcludedOfCutPlanes()

Return value

C++

0 = Error getting "excluded of cut planes" status.

1 = Success.

Python

True = object is excluded to cut planes.

...

LanguageSyntax
C++byte excludeOfCutPlanes( bool exclude )
Pythonint excludeOfCutPlanes( bool exclude )

Return value

0 = Error setting "excluded of cut planes" state.

...

TypeNameIn/OutDescription
const dword&percentinPercent of points of the mesh that will be returned.
const dword&maxPointsin

Maximum number of points that will be in the returned array (-1 means there is not a maximum fixed)

dword&nPointsoutNumber of points returned.

Return value

C++

Array of nPoints * 3 containing the proxy points requested.

Python

NumPy array containing  the proxy points requested. Shape is (nPoints,3).

...

LanguageSyntax
C++byte setColorID( const Crgb& color )
Pythonint setColorID( Crgb  color )

Return value

0 = Error setting color ID.

...

LanguageSyntax
C++byte getColorID( Crgb & color )
PythonCrgb  getColorID()

Return value

C++

0 = Error getting the color ID.

1 = Success.

Python

Crgb containing the color ID.

...

LanguageSyntax
C++byte setGeometryDirty()
Pythonint setGeometryDirty()

Return value

0 = Error setting geometry dirty.

...

LanguageSyntax
C++byte initializeMesh( dword nVertex, dword nNormals, dword nFaces, dword positionsPerVertex )
Pythonint initializeMesh( int nVertex, int nNormals, int nFaces, int positionsPerVertex )

Return value

0 = Error initializing mesh.

...

LanguageSyntax
C++byte resizeMesh( dword newNVertex, dword newNNormals, dword newNFaces, dword newNpositionsPerVertex )
Pythonint resizeMesh( int newNVertex, int newNNormals, int newNFaces, int newNpositionsPerVertex )

Return value

0 = Error resizing mesh.

1 = Success.

...

LanguageSyntax
C++byte generateCustomUVW( dword iChannel, dword iGeneratorType )
Pythonint generateCustomUVW( int iChannel, int iGeneratorType )

Return value

0 = Error generating custom UVW coordinates.

...

LanguageSyntax
C++byte getUVWChannelProperties( dword iChannel, byte& projType, bool& customProj, Cbase& projectorBase, real& startLatitude, real& endLatitude, real& startLongitude, real& endLongitude, real& startAngle, real& endAngle, bool& mirrorBackFaces )
Python

(int projType, bool custumProj, Cbase projectorBase, float startLatitude, float endLatutide, float startLongitude, float endLongitude, float startAngle, float endAngle, bool mirrorBackFaces) getUVWChannelProperties( int iChannel )

Return value

C++

0 = Error getting UVW channel properties.

1 = Success.

Python

Tuple containing the UVW channel properties.

...

LanguageSyntax
C++byte getGlobalXform( Cbase& xForm )
PythonCbase getGlobalXform()

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

...

LanguageSyntax
C++byte getGlobalNormalsXform( Cbase& xForm )
PythonCbase getGlobalNormalsXform()

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

...

LanguageSyntax
C++byte getInverseGlobalXform( Cbase& ixForm )
PythonCbase getInverseGlobalXform()

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

...

LanguageSyntax
C++byte getInverseGlobalNormalXform( Cbase& ixForm )
PythonCbase getInverseGlobalNormalXform()

Return value

C++

0 = Error getting  --TODO--

1 = Success.

Python

Cbase containing --TODO--

...

LanguageSyntax
C++byte isGeometryLoader( bool& isGeomExtension )
Pythonbool isGeometryLoader()

Return value

C++

0 = Error checking object was created from a geometry loader extension.

1 = Success.

Python

True = the object was created by a geometry loader extension.

...

LanguageSyntax
C++byte isGeometryProcedural( bool& isGeomProceduralExtension )
Pythonbool isGeometryProcedural()

Return value

C++

0 = Error checking object was created from a procedural geometry extension.

1 = Success.

Python

True = the object was created by a procedural geometry extension.

...

LanguageSyntax
C++byte hasGeometryModifiers( bool& isGeomModifiersExtension )
Pythonbool hasGeometryModifiers()

Return value

C++

0 = Error checking object have geometry modifiers (extensions).

1 = Success.

Python

True = the object have geometry modifiers (extensions).

...

LanguageSyntax
C++byte cleanAllGeometryModifierExtensions()
Pythonint cleanAllGeometryModifierExtensions()

Return value

0 = Error cleaning geometry modifier extensions.

...

LanguageSyntax
C++byte getGeometryModifierExtensionsNumber( dword& numModifierExtensions )
Pythonint getGeometryModifierExtensionsNumber()

Return value

C++

0 = Error getting the number of geometry modifier extensions applied to the object.

1 = Success.

Python

Number of geometry modifier extensions applied to the object.

...