11 #ifndef __BRAY_Interface__
12 #define __BRAY_Interface__
43 class BRAY_ShaderGraph;
44 class BRAY_ShaderInstance;
45 class BRAY_VexMaterial;
88 bool isValid()
const {
return mySpace.get() !=
nullptr; }
99 int motionSegments()
const;
132 bool canErase(
int token)
const;
139 bool isValid()
const {
return myOptions.get() !=
nullptr; }
147 exint numProperties()
const;
163 template <
typename T>
164 const T *
import(
int token,
T *
val,
size_t n)
const;
173 template <
typename T>
177 template <
typename T>
180 return set(token, &value, 1);
184 template <
typename T>
185 bool isEqual(
int token,
const T *
value,
exint tuple_size)
const;
188 template <
typename T>
191 return isEqual(token, &value, 1);
195 bool isVariadic(
int token)
const;
211 const bool *bval(
int token)
const;
212 const int64 *ival(
int token)
const;
213 const fpreal64 *fval(
int token)
const;
240 static void setExitOnFailedLicense(
bool state=
true);
247 bool isKarmaCPU()
const;
248 bool isKarmaXPU()
const;
254 bool isValid()
const {
return myScene.get() !=
nullptr; }
257 bool threadSafe()
const;
260 bool nestedInstancing()
const;
285 void saveCheckpointASAP();
310 const BRAY_Scene *
scenePtr()
const {
return myScene.get(); }
315 void commitOptions();
320 const OptionSet constSceneOptions()
const;
326 const OptionSet constObjectProperties()
const;
332 const OptionSet constLightProperties()
const;
337 const OptionSet constCameraProperties()
const;
342 const OptionSet constPlaneProperties()
const;
352 template <
typename T>
354 T *
val,
size_t n)
const
356 return constSceneOptions().import(token, val, n);
360 template <
typename T>
365 return sceneOptions().set(token, value, tuple_size);
369 template <
typename T>
373 return setOption(token, &value, 1);
380 return constSceneOptions().size(token);
387 return constSceneOptions().storage(token);
394 return constSceneOptions().isVariadic(token);
397 {
return *constSceneOptions().bval(t); }
399 {
return *constSceneOptions().ival(t); }
401 {
return *constSceneOptions().fval(t); }
403 {
return *constSceneOptions().sval(t); }
409 template <
typename T>
411 T *
val,
size_t n)
const
413 return constObjectProperties().import(token, val, n);
417 template <
typename T>
422 return objectProperties().set(token, value, tuple_size);
439 {
return lockProperties(
"*", state); }
442 template <
typename T>
446 return setProperty(token, &value, 1);
453 return constObjectProperties().size(token);
460 return constObjectProperties().storage(token);
467 return constObjectProperties().isVariadic(token);
470 {
return *constObjectProperties().bval(t); }
472 {
return *constObjectProperties().ival(t); }
474 {
return *constObjectProperties().fval(t); }
476 {
return *constObjectProperties().sval(t); }
544 bool loadHDA(
const char *
path);
565 : myGeometry(primvar)
566 , myParmName(shader_parm)
569 , myIsArray(is_array)
587 : myPrimvars(primvars)
596 bool isValid()
const {
return myPrimvars !=
nullptr; }
615 bool isValid()
const {
return myMat !=
nullptr; }
624 void updateSurface(
const ScenePtr &scene,
628 bool updateDisplace(
ScenePtr &scene,
631 void updateLens(
const ScenePtr &scene,
636 void updateSurfaceCode(
const ScenePtr &scene,
643 bool updateDisplaceCode(
const ScenePtr &scene,
649 void updateLensCode(
const ScenePtr &scene,
655 void updateSurfaceGraph(
const ScenePtr &scene,
660 bool updateDisplaceGraph(
ScenePtr &scene,
664 void updateLensGraph(
const ScenePtr &scene,
669 void setInputs(
const ScenePtr &scene,
682 BRAY_VexMaterial *myMat;
689 : myFaceList(facelist)
690 , myMaterial(material)
732 UT_ASSERT(o &&
"isA<> called with nullptr - use isAValid<>");
733 return X::classof(o);
741 return o && X::classof(o);
750 return static_cast<const X *
>(o);
759 return static_cast<X *
>(o);
768 return isAValid<X>(o) ? static_cast<const X *>(o) :
nullptr;
773 return isA<X>(&o) ? static_cast<const X *>(&o) :
nullptr;
778 return isAValid<X>(o) ? static_cast<X *>(o) :
nullptr;
783 return isA<X>(&o) ? static_cast<X *>(&o) :
nullptr;
803 bool isValid()
const {
return myObject !=
nullptr; }
811 const BRAY_Object *
objectPtr()
const {
return myObject.get(); }
826 bool setCoordSysAliases(
const ScenePtr &scene,
830 void setInstancePrototype(
const ObjectPtr &proto);
833 void setInstanceTransforms(
ScenePtr &scene,
837 void setInstanceAttributes(
const ScenePtr &scene,
844 void setInstanceProperties(
const ScenePtr &scene,
855 bool validateInstance()
const;
873 bool setGeometry(
const ScenePtr &scene,
878 bool setGeometry(
const ScenePtr &scene,
896 void takeOwnership(BRAY_Object *obj);
920 bool isValid()
const {
return myLight !=
nullptr; }
925 const BRAY_Light *
lightPtr()
const {
return myLight.get(); }
939 void setTransform(
const SpacePtr &xforms);
948 void setObjectProperties(
const OptionSet &oprops);
954 void setLightProperties(
const OptionSet &lprops);
957 void commitOptions(
ScenePtr &scene);
960 void updateShaderGraph(
const ScenePtr &scene,
967 void updateFilters(
const ScenePtr &scene,
971 void eraseFilter(
const ScenePtr &scene,
979 bool enable_color_temperature,
980 float color_temperature);
1005 bool isValid()
const {
return myInstancer !=
nullptr; }
1014 void setInstanceTransforms(
ScenePtr &scene,
1018 void setInstanceProperties(
ScenePtr &scene,
1057 bool isValid()
const {
return myCamera !=
nullptr; }
1062 const BRAY_Camera *
cameraPtr()
const {
return myCamera.get(); }
1073 void setShaderMaterial(
const ScenePtr &scene,
1082 void resizeCameraProperties(
int nseg);
1088 void clearClippingPlanes();
1091 void addClippingPlane(
const UT_Vector4D *plane,
int nsegments);
1094 void commitOptions(
ScenePtr &scene);
1111 bool isValid()
const {
return mySpace !=
nullptr; }
1117 const BRAY_Camera *
spacePtr()
const {
return mySpace.get(); }
1133 void resizeCameraProperties(
int nseg);
1157 {
return aov.myAOVBuffer == myAOVBuffer; }
1159 {
return !(*
this == aov); }
1164 int getXres()
const;
1165 int getYres()
const;
1168 float getDefaultValue()
const;
1172 bool isMapped()
const;
1175 int getNumExtra()
const;
1179 void *mapExtra(
int idx);
1180 void unmapExtra(
int idx);
1185 bool isConverged()
const;
1186 void setConverged();
1187 void clearConverged();
1190 bool isValid()
const;
1220 template <
typename T>
1224 template <
typename T>
1226 {
return setOption(name, &value, 1); }
1244 , myFilename(filename)
1261 template <
typename T>
1265 template <
typename T>
1267 {
return setOption(name, &value, 1); }
1276 myAOVs.emplace_back(name);
1277 return myAOVs.last();
1283 bool result = doCommit();
1336 void clearOutputPlanes();
1338 int getAOVCount()
const;
1348 bool prepareRender();
1351 void render(
bool (*stopreq)(
void *) =
nullptr,
void *
data =
nullptr);
1354 bool isRendering()
const;
1357 bool isError()
const;
1360 bool isPaused()
const;
1363 void prepareForStop();
1369 bool resumeRender();
1372 void setPriority(
int x,
int y);
1378 void clearPriority();
1383 bool enableImageFilters(
1385 bool is_render_settings_prim);
1388 void setUseRenderSettingsPrim(
bool use_render_settings_prim);
1394 BRAY_Renderer *renderer() {
return myRenderer.get(); }
1417 OptionSet nodeParams(BRAY_ShaderInstance *node);
1447 bool isInt()
const {
return myType == 1; }
1455 return myB.size() + myI.size() + myF.size() + myS.size();
1473 {
return myInputs; }
1475 {
return myOutputs; }
1477 {
return myMetadata; }
1482 { myInputs.append(parm); }
1484 { myOutputs.append(parm); }
1486 { myMetadata = metadata; }
1505 const OptionSet getObjectProperties()
const;
1509 void clearObjectProperties();
void cancel()
Cancel this output file for some reason.
BRAY_EventType
Types of events that can be sent as updates to the renderer.
AOV & appendAOV(const UT_StringHolder &name)
Add an AOV to this output file.
static SYS_FORCE_INLINE bool classof(const InstancablePtr *o)
Test if Instancable is of this type.
UT_StringHolder optionS(BRAY_SceneOption t) const
int64 propertyI(BRAY_SceneOption t) const
GT_API const UT_StringHolder filename
const BRAY_Camera * spacePtr() const
bool useAllPrimvars() const
Interface to scene materials.
const VPRM_SpacePtr & space() const
bool operator==(const AOVBufferPtr &aov) const
SYS_FORCE_INLINE const T * propertyImport(BRAY_ObjectProperty token, T *val, size_t n) const
const BRAY_Scene * scenePtr() const
bool commit()
Commit and add this output file to the render.
const BRAY_Camera * cameraPtr() const
void setName(const UT_StringHolder &n)
void addOutput(const Parameter &parm)
bool isValid() const
Test validity.
float BRAYtime
Consistent representation of time type within BRAY.
getFileOption("OpenEXR:storage") storage
bool operator!=(const AOVBufferPtr &aov) const
InstancablePtr(InstancableType type)
GLsizei const GLfloat * value
SYS_FORCE_INLINE bool isA(const InstancablePtr *o)
SYS_FORCE_INLINE bool setProperty(BRAY_ObjectProperty token, const T &value)
Simple interface to set a scalar property.
GLsizei const GLchar *const * path
AOV(const UT_StringHolder &name)
UT_SharedPtr< BRAY_Light > myLight
FacesetMaterial(const GT_DataArrayHandle &facelist=GT_DataArrayHandle(), const MaterialPtr &material=MaterialPtr())
const UT_Options & options() const
const UT_StringMap< UT_StringHolder > & metadata() const
CoordSysPtr(const UT_SharedPtr< BRAY_Camera > &sp=UT_SharedPtr< BRAY_Camera >())
const UT_Array< AOV > & aovs() const
const UT_StringHolder & name() const
SYS_FORCE_INLINE const T * optionImport(BRAY_SceneOption token, T *val, size_t n) const
const UT_StringHolder & filename() const
Access member data.
bool setOption(const UT_StringHolder &name, const T &value)
Class which writes ASCII or binary JSON streams.
int64 optionI(BRAY_SceneOption t) const
**But if you need a result
SYS_FORCE_INLINE bool set(int token, const T &value)
Simple interface to set a scalar property.
const BRAY_Object * objectPtr() const
FMT_CONSTEXPR auto find(Ptr first, Ptr last, T value, Ptr &out) -> bool
SYS_FORCE_INLINE exint propertySize(BRAY_ObjectProperty token) const
const UT_Array< Parameter > & inputs() const
const BRAY_Light * lightPtr() const
OutputFile(BRAY::ScenePtr &scene, const UT_StringHolder &filename, const UT_StringHolder &type)
bool isValid() const
Test validity.
CameraPtr(const UT_SharedPtr< BRAY_Camera > &cp=UT_SharedPtr< BRAY_Camera >())
static SYS_FORCE_INLINE bool classof(const InstancablePtr *o)
Test if Instancable is of this type.
IFDmantra you can see code vm_image_mplay_direction endcode When SOHO starts a render
const BRAY_VexMaterial * materialPtr() const
GLintptr GLsizeiptr GLboolean commit
SYS_FORCE_INLINE bool isEqual(int token, const T &value) const
Simple interface for equality of a scalar value.
UT_StringHolder propertyS(BRAY_SceneOption t) const
std::unique_ptr< T, Deleter > UT_UniquePtr
A smart pointer for unique ownership of dynamically allocated objects.
bool isValid() const
Test validity.
SYS_FORCE_INLINE X * dyn_castValid(InstancablePtr &o)
bool propertyB(BRAY_SceneOption t) const
VPRM_OptionSetPtr & options()
const UT_StringHolder name() const
GLint GLint GLsizei GLint GLenum GLenum type
SYS_FORCE_INLINE const X * cast(const InstancablePtr *o)
SYS_FORCE_INLINE GT_Storage propertyStorage(BRAY_ObjectProperty token) const
Return the storage class of an option.
UT_SharedPtr< BRAY_Camera > myCamera
BRAY_RayVisibility
Ray visibility flags.
UT_SharedPtr< BRAY_Object > myObject
UT_Array< UT_StringHolder > myS
BRAY_Camera * cameraPtr()
std::shared_ptr< T > UT_SharedPtr
Wrapper around std::shared_ptr.
UT_IntrusivePtr< GT_DataArray > GT_DataArrayHandle
SYS_FORCE_INLINE exint optionSize(BRAY_SceneOption token) const
PXL_API const char * getName(const ColorSpace *space)
Return the name of the color space.
constexpr auto set(type rhs) -> int
void setMetadata(const UT_StringMap< UT_StringHolder > &metadata)
ShaderGraphPtr(UT_SharedPtr< BRAY_ShaderGraph > graph)
static SYS_FORCE_INLINE bool classof(const InstancablePtr *o)
Test if Instancable is of this type.
UT_StringHolder myVariable
NodeDecl(const UT_StringHolder &n)
PrimvarSet(const UT_Set< UT_StringHolder > *primvars)
SYS_FORCE_INLINE bool optionIsVariadic(BRAY_SceneOption token) const
Return whether an option has variadic arguments.
SYS_FORCE_INLINE bool setOption(BRAY_SceneOption token, const T *value, exint tuple_size)
Interface to set an option. This template class is specialized for:
SYS_FORCE_INLINE exint lockAllObjectProperties(bool state)
Lock or unlock all object properties.
const UT_Array< Parameter > & outputs() const
bool isValid() const
Test validity.
Class used to define image planes.
GLuint const GLchar * name
GA_API const UT_StringHolder transform
const UT_Options & options() const
GT_DataArrayHandle myFaceList
SYS_FORCE_INLINE bool isAValid(const InstancablePtr *o)
SYS_FORCE_INLINE bool setOption(BRAY_SceneOption token, const T &value)
Simple interface to set a scalar option.
PXL_DataFormat myDataFormat
A map of string to various well defined value types.
A render product represents an output file.
fpreal64 optionF(BRAY_SceneOption t) const
UT_SharedPtr< LightInstancer > myInstancer
MaterialPtr(BRAY_VexMaterial *mat=nullptr)
LeafData & operator=(const LeafData &)=delete
VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE Result createInstance(const VULKAN_HPP_NAMESPACE::InstanceCreateInfo *pCreateInfo, const VULKAN_HPP_NAMESPACE::AllocationCallbacks *pAllocator, VULKAN_HPP_NAMESPACE::Instance *pInstance, Dispatch const &d) VULKAN_HPP_NOEXCEPT
const UT_Set< UT_StringHolder > * primvars() const
SYS_FORCE_INLINE bool setProperty(BRAY_ObjectProperty token, const T *value, exint tuple_size)
Interface to set an property. This template class is specialized for:
AOVBufferPtr(const UT_SharedPtr< BRAY_AOVBuffer > &aov)
SYS_FORCE_INLINE bool propertyIsVariadic(BRAY_ObjectProperty token) const
Return whether an property has variadic arguments.
bool isValid() const
Test validity.
Class to store JSON objects as C++ objects.
**If you just want to fire and args
void addInput(const Parameter &parm)
GLubyte GLubyte GLubyte GLubyte w
bool setOption(const UT_StringHolder &name, const T &value)
std::shared_ptr< class ShaderMaterial > MaterialPtr
InstancableType instancableType() const
bool optionB(BRAY_SceneOption t) const
Interface to the renderer.
const UT_StringHolder & type() const
fpreal64 propertyF(BRAY_SceneOption t) const
LightInstancerPtr(UT_SharedPtr< LightInstancer > p=nullptr)
SYS_FORCE_INLINE const X * dyn_cast(const InstancablePtr *o)
const VPRM_OptionSetPtr & options() const
BRAY_Object * objectPtr()
LightPtr(const UT_SharedPtr< BRAY_Light > &lp=UT_SharedPtr< BRAY_Light >())
SYS_FORCE_INLINE GT_Storage optionStorage(BRAY_SceneOption token) const
Return the storage class of an option.